shard

Documentation

Index

• type Key
  • func KeyFromBytes(b []byte) Key
  • func KeyFromCID(cid cid.Cid) Key
  • func KeyFromString(str string) Key
  • func (k Key) MarshalJSON() ([]byte, error)
  • func (k Key) String() string
  • func (k *Key) UnmarshalJSON(bz []byte) error

Types

type Key

type Key struct {
	// contains filtered or unexported fields
}

Key represents a shard key. It can be instantiated from a string, a byte slice, or a CID.

func KeyFromBytes

func KeyFromBytes(b []byte) Key

KeyFromBytes returns a key from a byte slice, encoding it in b58 first.

func KeyFromCID

func KeyFromCID(cid cid.Cid) Key

KeyFromCID returns a key representing a CID.

func KeyFromString

func KeyFromString(str string) Key

KeyFromString returns a key representing an arbitrary string.

func (Key) MarshalJSON

func (k Key) MarshalJSON() ([]byte, error)

We need a custom JSON marshaller and unmarshaller because str is a private field

func (Key) String

func (k Key) String() string

String returns the string representation for this key.

func (*Key) UnmarshalJSON

func (k *Key) UnmarshalJSON(bz []byte) error