cbornode

README

go-ipld-cbor

An implementation of a cbor encoded merkledag object.

Table of Contents

• Install
• Usage
• API
• Contribute
• License

Install

make install

Usage

TODO: Right now this package isn't the easiest to use, it will be getting better rapidly, soon.

// Make an object
obj := map[interface{}]interface{}{
	"foo": "bar",
	"baz": &Link{
		Target: myCid,
	},
}

// Parse it into an ipldcbor node
nd, err := WrapMap(obj)

fmt.Println(nd.Links())

Contribute

PRs are welcome!

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © Jeromy Johnson

Documentation

Index

• Variables
• func DecodeInto(b []byte, v interface{}) error
• func EncodeObject(obj interface{}) ([]byte, error)
• type Link
  • func (l *Link) ToCBOR(w io.Writer, enc *cbor.Encoder) error
• type Node
  • func Decode(b []byte) (*Node, error)
  • func WrapMap(m map[interface{}]interface{}) (*Node, error)
  • func (n Node) Cid() *cid.Cid
  • func (n Node) Links() []*node.Link
  • func (n Node) Loggable() map[string]interface{}
  • func (n Node) MarshalJSON() ([]byte, error)
  • func (n Node) RawData() []byte
  • func (n Node) Resolve(path []string) (interface{}, []string, error)
  • func (n Node) ResolveLink(path []string) (*node.Link, []string, error)
  • func (n Node) Size() (uint64, error)
  • func (n Node) Stat() (*node.NodeStat, error)
  • func (n Node) String() string
  • func (n Node) Tree() []string

Variables

var ErrNoSuchLink = errors.New("no such link found")

Functions

func DecodeInto

func DecodeInto(b []byte, v interface{}) error

DecodeInto decodes a serialized ipld cbor object into the given object.

func EncodeObject

func EncodeObject(obj interface{}) ([]byte, error)

Types

type Link

type Link struct {
	Target *cid.Cid `json:"/" cbor:"/"`
}

func (*Link) ToCBOR

func (l *Link) ToCBOR(w io.Writer, enc *cbor.Encoder) error

type Node

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

func Decode

func Decode(b []byte) (*Node, error)

func WrapMap

func WrapMap(m map[interface{}]interface{}) (*Node, error)

func (Node) Cid

func (n Node) Cid() *cid.Cid

func (Node) Links

func (n Node) Links() []*node.Link

func (Node) Loggable

func (n Node) Loggable() map[string]interface{}

func (Node) MarshalJSON

func (n Node) MarshalJSON() ([]byte, error)

func (Node) RawData

func (n Node) RawData() []byte

func (Node) Resolve

func (n Node) Resolve(path []string) (interface{}, []string, error)

func (Node) ResolveLink

func (n Node) ResolveLink(path []string) (*node.Link, []string, error)

func (Node) Size

func (n Node) Size() (uint64, error)

func (Node) Stat

func (n Node) Stat() (*node.NodeStat, error)

func (Node) String

func (n Node) String() string

func (Node) Tree

func (n Node) Tree() []string