identity

Documentation

Overview

Package identity defines the ID format used for uniquely identifying objects in Arigato.

Index

• type ID
  • func DecodeFromString(value string) (ID, error)
  • func Immutable(body Identifiable, sig interface{}) (ID, error)
  • func Mutable(body Identifiable) (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

Types

type ID

type ID [18]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

func DecodeFromString(value string) (ID, error)

DecodeFromString returns an ID that is stored in the given string.

func Immutable

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

Immutable returns a new signed ID for an immutable object.

sig should be a registry.Signature type

func Mutable

func Mutable(body Identifiable) (ID, error)

Mutable returns a new ID for a mutable object.

func (*ID) MarshalJSON

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

MarshalJSON implements the json.Marshaler interface for IDs.

IDs are encoded in unpadded base32.

func (*ID) String

func (id *ID) String() string

func (*ID) Type

func (id *ID) Type() byte

Type returns the binary encoded object type represented by this ID.

func (*ID) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaler interface for IDs.

type Identifiable

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

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