unit

Documentation

Index

• Constants
• type Name
  • func NewName(name string) (Name, error)
  • func NewNameFromParts(applicationName string, number int) (Name, error)
  • func (n Name) String() string
  • func (n Name) Validate() error
• type UUID
  • func NewUUID() (UUID, error)
  • func ParseID(value string) (UUID, error)
  • func (u UUID) String() string
  • func (u UUID) Validate() error

Constants

const (
	InvalidUnitName = errors.ConstError("invalid unit name")
)

Types

type Name

type Name string

Name represents a units name, used as a human-readable unique identifier.

func NewName

func NewName(name string) (Name, error)

NewName returns a new Name. If the name is invalid, an InvalidUnitName error will be returned.

func NewNameFromParts

func NewNameFromParts(applicationName string, number int) (Name, error)

NewNameFromParts returns a new Name from the application and number parts. If the name is invalid, an InvalidUnitName error will be returned.

func (Name) String

func (n Name) String() string

String returns the Name as a string.

func (Name) Validate

func (n Name) Validate() error

Validate returns an error if the Name is invalid. The returned error is an InvalidUnitName error.

type UUID

type UUID string

UUID represents a unit unique identifier.

func NewUUID

func NewUUID() (UUID, error)

NewUUID is a convince function for generating a new unit uuid.

func ParseID

func ParseID(value string) (UUID, error)

ParseID returns a new UUID from the given string. If the string is not a valid uuid an error satisfying errors.NotValid will be returned.

func (UUID) String

func (u UUID) String() string

String implements the stringer interface for UUID.

func (UUID) Validate

func (u UUID) Validate() error

Validate ensures the consistency of the UUID. If the uuid is invalid an error satisfying errors.NotValid will be returned.