Documentation
¶
Index ¶
- Constants
- Variables
- func DecodeCommit(block blocks.Block) (format.Node, error)
- func DecodeRepository(block blocks.Block) (format.Node, error)
- type Commit
- func (c *Commit) Cid() cid.Cid
- func (c *Commit) Copy() format.Node
- 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
- type References
- type Repository
- func (r *Repository) Cid() cid.Cid
- func (r *Repository) Copy() format.Node
- func (r *Repository) Links() []*format.Link
- func (r *Repository) Loggable() map[string]interface{}
- func (r *Repository) RawData() []byte
- func (r *Repository) Resolve(path []string) (interface{}, []string, error)
- func (r *Repository) ResolveLink(path []string) (*format.Link, []string, error)
- func (r *Repository) Size() (uint64, error)
- func (r *Repository) Stat() (*format.NodeStat, error)
- func (r *Repository) String() string
- func (r *Repository) Tree(path string, depth int) []string
Constants ¶
const ( // RepositoryCodec is the multicodec value for repositories. RepositoryCodec = 0x300000 // CommitCodec is the multicodec value for repositories. 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.
func DecodeRepository ¶
func DecodeRepository(block blocks.Block) (format.Node, error)
DecodeRepository 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"`
// WorkTree is the current state of the repo files.
WorkTree cid.Cid `json:"tree"`
// Parents contains the CIDs of parent commits.
Parents Parents `json:"parents"`
}
Commit contains info about changes to a repo.
func (*Commit) Copy ¶
func (c *Commit) Copy() format.Node
Copy will go away. It is here to comply with the Node interface.
func (*Commit) Links ¶
func (c *Commit) Links() []*format.Link
Links is a helper function that returns all links within this object
func (*Commit) Resolve ¶
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 ¶
ResolveLink is a helper function that calls resolve and asserts the output is a link
type Parents ¶
Parents contains parent commit CIDs.
type References ¶
References is a mapping of names to commit CIDs.
type Repository ¶
type Repository struct {
// Branches contains references to versions.
Branches References `json:"branches"`
// Tags contains references to versions.
Tags References `json:"tags"`
}
Repository contains references to branches and tags.
func (*Repository) Copy ¶
func (r *Repository) Copy() format.Node
Copy will go away. It is here to comply with the Node interface.
func (*Repository) Links ¶
func (r *Repository) Links() []*format.Link
Links is a helper function that returns all links within this object
func (*Repository) Loggable ¶
func (r *Repository) Loggable() map[string]interface{}
Loggable returns a go-log loggable item.
func (*Repository) RawData ¶
func (r *Repository) RawData() []byte
RawData returns the block raw contents as a byte slice.
func (*Repository) Resolve ¶
func (r *Repository) 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 (*Repository) ResolveLink ¶
func (r *Repository) ResolveLink(path []string) (*format.Link, []string, error)
ResolveLink is a helper function that calls resolve and asserts the output is a link
func (*Repository) Size ¶
func (r *Repository) Size() (uint64, error)
Size returns the size in bytes of the serialized object
func (*Repository) Stat ¶
func (r *Repository) Stat() (*format.NodeStat, error)
Stat returns info about the node.
func (*Repository) String ¶
func (r *Repository) String() string
String returns a string representation of the commit.