ipldmulti

README

Multiverse IPLD Codec

About

IPLD codec for Multiverse objects.

License

GNU Affero General Public License v3.0

Documentation

Index

• Constants
• Variables
• func DecodeCommit(block blocks.Block) (format.Node, error)
• type Commit
  • func (c *Commit) Cid() cid.Cid
  • func (c *Commit) Copy() format.Node
  • func (c *Commit) Hash() multihash.Multihash
  • func (c *Commit) Links() []*format.Link
  • func (c *Commit) Loggable() map[string]interface{}
  • func (c *Commit) RawData() []byte
  • func (c *Commit) Resolve(path []string) (interface{}, []string, error)
  • func (c *Commit) ResolveLink(path []string) (*format.Link, []string, error)
  • func (c *Commit) Size() (uint64, error)
  • func (c *Commit) Stat() (*format.NodeStat, error)
  • func (c *Commit) String() string
  • func (c *Commit) Tree(path string, depth int) []string
• type Parents
  • func (p Parents) Resolve(path []string) (interface{}, []string, error)
  • func (p Parents) Tree(path string, depth int) []string

Constants

const (
	// CommitCodec is the multicodec id for commits.
	CommitCodec = 0x300001
)

Variables

var (
	// ErrNoLink is returned when an invalid path is resolved.
	ErrNoLink = errors.New("no such link")
	// ErrZeroLenPath is returned when a path of len zero is resolved.
	ErrZeroLenPath = errors.New("zero length path")
)

Functions

func DecodeCommit

func DecodeCommit(block blocks.Block) (format.Node, error)

DecodeCommit is a block decoder for raw IPLD nodes.

Types

type Commit

type Commit struct {
	// Date is the timestamp of when the commit was created.
	Date time.Time `json:"date"`
	// Message is a description of the changes.
	Message string `json:"message"`
	// Parents contains the CIDs of parent commits.
	Parents Parents `json:"parents"`
	// PeerID is the hash of the author's public key.
	PeerID peer.ID `json:"peer_id"`
	// WorkTree is the current state of the repo files.
	WorkTree cid.Cid `json:"tree"`
	// contains filtered or unexported fields
}

Commit contains info about changes to a repo.

func (*Commit) Cid

func (c *Commit) Cid() cid.Cid

Cid returns the cid of the commit.

func (*Commit) Copy

func (c *Commit) Copy() format.Node

Copy will go away. It is here to comply with the Node interface.

func (*Commit) Hash

func (c *Commit) Hash() multihash.Multihash

Hash returns the multihash of the block.

func (*Commit) Links

func (c *Commit) Links() []*format.Link

Links is a helper function that returns all links within this object

func (*Commit) Loggable

func (c *Commit) Loggable() map[string]interface{}

Loggable returns a go-log loggable item.

func (*Commit) RawData

func (c *Commit) RawData() []byte

RawData returns the block raw contents as a byte slice.

func (*Commit) Resolve

func (c *Commit) Resolve(path []string) (interface{}, []string, error)

Resolve resolves a path through this node, stopping at any link boundary and returning the object found as well as the remaining path to traverse

func (*Commit) ResolveLink

func (c *Commit) ResolveLink(path []string) (*format.Link, []string, error)

ResolveLink is a helper function that calls resolve and asserts the output is a link

func (*Commit) Size

func (c *Commit) Size() (uint64, error)

Size returns the size in bytes of the serialized object

func (*Commit) Stat

func (c *Commit) Stat() (*format.NodeStat, error)

Stat returns info about the node.

func (*Commit) String

func (c *Commit) String() string

String returns a string representation of the commit.

func (*Commit) Tree

func (c *Commit) Tree(path string, depth int) []string

Tree lists all paths within the object under 'path', and up to the given depth. To list the entire object (similar to `find .`) pass "" and -1

type Parents

type Parents []cid.Cid

Parents contains parent commit CIDs.

func (Parents) Resolve

func (p Parents) Resolve(path []string) (interface{}, []string, error)

Resolve resolves a path through this node, stopping at any link boundary and returning the object found as well as the remaining path to traverse

func (Parents) Tree

func (p Parents) Tree(path string, depth int) []string

Tree lists all paths within the object under 'path', and up to the given depth. To list the entire object (similar to `find .`) pass "" and -1