identity

type ID ¶

type ID [byteLength]byte

ID is an encoded unique identifier for an object.

The first byte holds the schema version of the id itself. The second byte holds the type of the object. The remaining 16 bytes hold a digest of the contents of the object for immutable objects, or a random value for mutable objects.

func DecodeFromString(value string) (ID, error)

func DeriveMutable(body Mutable, base *ID, derivableType byte) ID

func NewImmutable(body Immutable, sig interface{}) (ID, error)

func NewMutable(body Mutable) (ID, error)

func (id *ID) MarshalJSON() ([]byte, error)

func (id *ID) String() string

func (id *ID) Type() byte

func (id *ID) UnmarshalJSON(b []byte) error

type Identifiable ¶

type Identifiable interface {
	Version() int
	Type() byte
}

Identifiable is the interface implemented by objects that can be given IDs.

type Immutable ¶

type Immutable interface {
	Identifiable
	Immutable() // We don't ever need to call this, its just for type checking.
}

Immutable structs are Identifiables that do not change, and should be signed.

type Mutable ¶

type Mutable interface {
	Identifiable
	Mutable() // also just for type checking.
}

Mutable structs are Identifiables that can be changed.