common

Documentation

Index

• Variables
• func Copy(dst, src Storage) error
• type Storage

Variables

var ErrNoSpace = logicerr.New("no free space")

ErrNoSpace MUST be returned when there is no space to put an object on the device.

var ErrReadOnly = logicerr.New("opened as read-only")

ErrReadOnly MUST be returned for modifying operations when the storage was opened in readonly mode.

Functions

func Copy

func Copy(dst, src Storage) error

Copy copies all objects from source Storage into the destination one. If any object cannot be stored, Copy immediately fails.

Types

type Storage

type Storage interface {
	Open(readOnly bool) error
	Init() error
	Close() error

	Type() string
	Path() string
	SetLogger(*zap.Logger)
	SetCompressor(cc *compression.Config)

	// GetBytes reads object by address into memory buffer in a canonical NeoFS
	// binary format. Returns [apistatus.ObjectNotFound] if object is missing.
	GetBytes(oid.Address) ([]byte, error)
	Get(oid.Address) (*objectSDK.Object, error)
	GetRange(oid.Address, uint64, uint64) ([]byte, error)
	Exists(oid.Address) (bool, error)
	Put(oid.Address, []byte) error
	Delete(oid.Address) error
	Iterate(func(oid.Address, []byte, []byte) error, func(oid.Address, error) error) error
	IterateAddresses(func(oid.Address) error, bool) error
}

Storage represents key-value object storage. It is used as a building block for a blobstor of a shard.