root

Documentation

Overview

Package root defines a storage representation for pointers to file trees and associated metadata.

Index

• Variables
• func Encode(r *Root) *wiretype.Object
• type Options
• type Root
  • func Decode(s blob.KV, obj *wiretype.Object) (*Root, error)
  • func New(s blob.KV, opts *Options) *Root
  • func Open(ctx context.Context, s blob.KV, key string) (*Root, error)
  • func (r *Root) Chain(ctx context.Context, s wiretype.Getter) (*Root, error)
  • func (r *Root) File(ctx context.Context, s blob.CAS) (*file.File, error)
  • func (r *Root) Save(ctx context.Context, key string) error
  • func (r *Root) SaveChain(ctx context.Context, s blob.CAS) (string, error)

Variables

var ErrNoData = errors.New("requested data not found")

ErrNoData indicates that the requested data do not exist.

Functions

func Encode

func Encode(r *Root) *wiretype.Object

Encode encodes r as a protobuf message for storage.

Types

type Options

type Options struct {
	FileKey     string
	Description string
	IndexKey    string
	ChainKey    string
}

Options are configurable settings for creating a Root. A nil options pointer provides zero values for all fields.

type Root

type Root struct {
	Description string // a human-readable description
	FileKey     string // the storage key of the file node
	IndexKey    string // the storage key of the blob index
	ChainKey    string // the storage key of a predecessor root
	// contains filtered or unexported fields
}

A Root records the location of the root of a file tree.

func Decode

func Decode(s blob.KV, obj *wiretype.Object) (*Root, error)

Decode decodes a protobuf-encoded root record and associates it with the storage in s.

func New

func New(s blob.KV, opts *Options) *Root

New constructs a new empty Root associated with the given store. If opts != nil, initial values are set from its contents.

func Open

func Open(ctx context.Context, s blob.KV, key string) (*Root, error)

Open opens a stored root record given its storage key in s.

func (*Root) Chain

func (r *Root) Chain(ctx context.Context, s wiretype.Getter) (*Root, error)

Chain loads and returns the chained root of r from s, if one exists. If no chained root exists, it returns ErrNoData.

func (*Root) File

func (r *Root) File(ctx context.Context, s blob.CAS) (*file.File, error)

File loads and returns the root file of r from s, if one exists. If no file exists, it returns ErrNoData.

func (*Root) Save

func (r *Root) Save(ctx context.Context, key string) error

Save writes r in wire format to the given storage key.

func (*Root) SaveChain

func (r *Root) SaveChain(ctx context.Context, s blob.CAS) (string, error)

SaveChain writes r in wire format to the specified blob.CAS, and returns its storage key.