root

package

v0.4.1 Latest Latest Go to latest Published: Mar 15, 2024 License: Apache-2.0 Imports: 7 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/creachadair/ffs

Links

Open Source Insights

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 (r *Root) File(ctx context.Context, s blob.CAS) (*file.File, error)
- func (r *Root) Save(ctx context.Context, key string, replace bool) error

Constants ¶

This section is empty.

Variables ¶

View Source

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
}

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
	// contains filtered or unexported fields
}

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

func Decode ¶

func Decode(s blob.CAS, 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.CAS, 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.CAS, key string) (*Root, error)

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

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. If s == nil, it uses the same store as r.

func (*Root) Save ¶

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

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

Source Files ¶

View all Source files

root.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL