metadata

Documentation

Index

• func EncodeMetadata(entries Metadata) ([]byte, error)
• type Item
  • func (t *Item) MarshalCBOR(w io.Writer) error
  • func (t *Item) UnmarshalCBOR(r io.Reader) error
• type Metadata
  • func DecodeMetadata(data []byte) (Metadata, error)

Functions

func EncodeMetadata

func EncodeMetadata(entries Metadata) ([]byte, error)

EncodeMetadata encodes metadata to an IPLD node then serializes to raw bytes

Types

type Item

type Item struct {
	Link         cid.Cid
	BlockPresent bool
}

Item is a single link traversed in a repsonse

func (*Item) MarshalCBOR

func (t *Item) MarshalCBOR(w io.Writer) error

func (*Item) UnmarshalCBOR

func (t *Item) UnmarshalCBOR(r io.Reader) error

type Metadata

type Metadata []Item

Metadata is information about metadata contained in a response, which can be serialized back and forth to bytes

func DecodeMetadata

func DecodeMetadata(data []byte) (Metadata, error)

DecodeMetadata assembles metadata from a raw byte array, first deserializing as a node and then assembling into a metadata struct.