value

Documentation

Index

• type ID
  • func (k *ID) Key() []byte
  • func (k *ID) Namespace() string
  • func (k *ID) String() string
  • func (k *ID) ValidKey() error
• type Keyed
• type Secure
  • func NewSecureValue(id string, data []byte) *Secure
  • func (e *Secure) GetMetadata(k string) (v interface{})
  • func (e *Secure) SetMetadata(k string, v interface{})

Types

type ID

type ID struct {
	ID string `json:"id"`
}

ID provides a implementation of the Keyed interface. It can be embedded in another structure to build custom Keyed values.

func (*ID) Key

func (k *ID) Key() []byte

Key returns the key as bytes.

func (*ID) Namespace

func (k *ID) Namespace() string

Namespace is the namespace to use when storing the key.

func (*ID) String

func (k *ID) String() string

String returns the key as a string.

func (*ID) ValidKey

func (k *ID) ValidKey() error

ValidKey checks the key is valid.

type Keyed

type Keyed interface {
	// Key is the byte representation of the key.
	Key() []byte

	// Namespace is the namespace to use when storing the key.
	Namespace() string

	// ValidKey returns nil if the key is valid, otherwise ErrInvalidKey.
	ValidKey() error
}

Keyed provides a management interface for keyed values.

type Secure

type Secure struct {
	ID
	Data     []byte                 `json:"data,secure"`
	Metadata map[string]interface{} `json:"metadata"`
}

Secure provides a simple value for storing sparsely encrypted blobs and plaintext metadata.

func NewSecureValue

func NewSecureValue(id string, data []byte) *Secure

NewSecureValue returns a new Secure value.

func (*Secure) GetMetadata

func (e *Secure) GetMetadata(k string) (v interface{})

GetMetadata gets the metadata entry for k and returns it as v.

func (*Secure) SetMetadata

func (e *Secure) SetMetadata(k string, v interface{})

SetMetadata sets the metadata entry for k to v.