local

Documentation

Index

• Constants
• func Diff(ctx context.Context, ds ipld.DAGService, a, b ipld.Node) ([]*du.Change, error)
• func Ignore(pth string) bool
• type Bucket
  • func NewBucket(pth string, layout options.Layout) (*Bucket, error)
  • func (b *Bucket) Close() error
  • func (b *Bucket) Diff(ctx context.Context, pth string) (diff []*du.Change, err error)
  • func (b *Bucket) Get(ctx context.Context, c cid.Cid) (ipld.Node, error)
  • func (b *Bucket) HashFile(pth string) (cid.Cid, error)
  • func (b *Bucket) MatchPath(pth string, local, remote cid.Cid) (bool, error)
  • func (b *Bucket) RemovePath(ctx context.Context, pth string) error
  • func (b *Bucket) Root() (local, remote cid.Cid, err error)
  • func (b *Bucket) Save(ctx context.Context) error
  • func (b *Bucket) SaveFile(ctx context.Context, pth string, name string) error
  • func (b *Bucket) SetCidVersion(v int)
  • func (b *Bucket) SetRemotePath(pth string, remote cid.Cid) error

Constants

const (

	// PatchExt is used to ignore tmp files during a pull.
	PatchExt = ".buckpatch"
)

Functions

func Diff

func Diff(ctx context.Context, ds ipld.DAGService, a, b ipld.Node) ([]*du.Change, error)

Diff returns a set of changes that transform node 'a' into node 'b'. Modified from https://github.com/ipfs/go-merkledag/blob/master/dagutils/diff.go#L104 It only traverses links in the following cases: 1. two node's links number are greater than 0. 2. both of two nodes are ProtoNode. 3. neither of the nodes is a file node, which contains only unnamed raw blocks Otherwise, it compares the cid and emits a Mod change object.

func Ignore

func Ignore(pth string) bool

Ignore returns true if the path contains an ignored file.

Types

type Bucket

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

Bucket tracks a local bucket tree structure.

func NewBucket

func NewBucket(pth string, layout options.Layout) (*Bucket, error)

NewBucket creates a new bucket with the given path.

func (*Bucket) Close

func (b *Bucket) Close() error

Close closes the store and blocks service.

func (*Bucket) Diff

func (b *Bucket) Diff(ctx context.Context, pth string) (diff []*du.Change, err error)

Diff returns a list of changes that are present in path compared to the bucket.

func (*Bucket) Get

func (b *Bucket) Get(ctx context.Context, c cid.Cid) (ipld.Node, error)

Get returns the node at cid from the bucket.

func (*Bucket) HashFile

func (b *Bucket) HashFile(pth string) (cid.Cid, error)

HashFile returns the cid of the file at path. This method does not alter the bucket.

func (*Bucket) MatchPath

func (b *Bucket) MatchPath(pth string, local, remote cid.Cid) (bool, error)

MatchPath returns whether or not the path exists and has matching local and remote cids.

func (*Bucket) RemovePath

func (b *Bucket) RemovePath(ctx context.Context, pth string) error

RemovePath removes a local path map from the store.

func (*Bucket) Root

func (b *Bucket) Root() (local, remote cid.Cid, err error)

Root returns the local and remote root cids.

func (*Bucket) Save

func (b *Bucket) Save(ctx context.Context) error

Save saves the bucket as a node describing the file tree at the current path.

func (*Bucket) SaveFile

func (b *Bucket) SaveFile(ctx context.Context, pth string, name string) error

SaveFile saves the bucket as a node describing a directory containing reader.

func (*Bucket) SetCidVersion

func (b *Bucket) SetCidVersion(v int)

CidVersion returns the configured cid version (0 or 1). The default version is 1.

func (*Bucket) SetRemotePath

func (b *Bucket) SetRemotePath(pth string, remote cid.Cid) error

SetRemotePath sets or creates a mapping from a local path to a remote cid.