fstree

Documentation

Index

• Constants
• Variables
• type FSTree
  • func (t *FSTree) Delete(addr *objectSDK.Address) error
  • func (t *FSTree) Exists(addr *objectSDK.Address) (string, error)
  • func (t *FSTree) Get(addr *objectSDK.Address) ([]byte, error)
  • func (t *FSTree) Iterate(prm *IterationPrm) error
  • func (t *FSTree) NumberOfObjects() (uint64, error)
  • func (t *FSTree) Put(addr *objectSDK.Address, data []byte) error
• type Info
• type IterationPrm
  • func (p *IterationPrm) WithHandler(f func(addr *objectSDK.Address, data []byte) error) *IterationPrm
  • func (p *IterationPrm) WithIgnoreErrors(ignore bool) *IterationPrm

Constants

const (
	// DirNameLen is how many bytes is used to group keys into directories.
	DirNameLen = 1 // in bytes
	// MaxDepth is maximum depth of nested directories.
	MaxDepth = (sha256.Size - 1) / DirNameLen
)

Variables

var ErrFileNotFound = errors.New("file not found")

ErrFileNotFound is returned when file is missing.

Types

type FSTree

type FSTree struct {
	Info

	Depth      int
	DirNameLen int
}

FSTree represents object storage as filesystem tree.

func (*FSTree) Delete

func (t *FSTree) Delete(addr *objectSDK.Address) error

Delete removes object with the specified address from storage.

func (*FSTree) Exists

func (t *FSTree) Exists(addr *objectSDK.Address) (string, error)

Exists returns path to file with object contents if it exists in storage and an error otherwise.

func (*FSTree) Get

func (t *FSTree) Get(addr *objectSDK.Address) ([]byte, error)

Get returns object from storage by address.

func (*FSTree) Iterate

func (t *FSTree) Iterate(prm *IterationPrm) error

Iterate iterates over all stored objects.

func (*FSTree) NumberOfObjects

func (t *FSTree) NumberOfObjects() (uint64, error)

NumberOfObjects walks the file tree rooted at FSTree's root and returns number of stored objects.

func (*FSTree) Put

func (t *FSTree) Put(addr *objectSDK.Address, data []byte) error

Put puts object in storage.

type Info

type Info struct {
	// Permission bits of the root directory.
	Permissions fs.FileMode

	// Full path to the root directory.
	RootPath string
}

Info groups the information about file storage.

type IterationPrm

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

IterationPrm contains iteraction parameters.

func (*IterationPrm) WithHandler

func (p *IterationPrm) WithHandler(f func(addr *objectSDK.Address, data []byte) error) *IterationPrm

WithHandler sets a function to call on each object.

func (*IterationPrm) WithIgnoreErrors

func (p *IterationPrm) WithIgnoreErrors(ignore bool) *IterationPrm

WithIgnoreErrors sets a flag indicating whether errors should be ignored.