localstore

type Address ¶

type Address = refs.Address

Address is a type alias of Address from refs package of neofs-api-go.

type CID ¶

type CID = refs.CID

CID is a type alias of CID from refs package of neofs-api-go.

type FilterCode ¶

type FilterCode int

FilterCode is an enumeration of filter return codes.

const (
	// CodeUndefined is a undefined FilterCode.
	CodeUndefined FilterCode = iota

	// CodePass is a FilterCode of filter passage.
	CodePass

	// CodeFail is a FilterCode of filter failure.
	CodeFail

	// CodeIgnore is a FilterCode of filter ignoring.
	CodeIgnore
)

func (r FilterCode) String() string

type FilterFunc ¶

type FilterFunc func(ctx context.Context, meta *ObjectMeta) *FilterResult

FilterFunc is a function that checks whether an ObjectMeta matches a specific criterion.

func ContainerFilterFunc(cidList []CID) FilterFunc

func StoredEarlierThanFilterFunc(epoch uint64) FilterFunc

type FilterParams ¶

type FilterParams struct {
	Name       string
	Priority   uint64
	FilterFunc FilterFunc
}

FilterParams groups the parameters of FilterPipeline constructor.

type FilterPipeline ¶

type FilterPipeline interface {
	Pass(ctx context.Context, meta *ObjectMeta) *FilterResult
	PutSubFilter(params SubFilterParams) error
	GetPriority() uint64
	SetPriority(uint64)
	GetName() string
}

FilterPipeline is an interface of ObjectMeta filtering tool with sub-filters and priorities.

func AllPassIncludingFilter(name string, params ...*FilterParams) (FilterPipeline, error)

func NewFilter(p *FilterParams) FilterPipeline

type FilterResult ¶

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

FilterResult groups of ObjectMeta filter result values.

func ResultFail() *FilterResult

func ResultIgnore() *FilterResult

func ResultPass() *FilterResult

func ResultUndefined() *FilterResult

func ResultWithError(c FilterCode, e error) *FilterResult

func SkippingFilterFunc(_ context.Context, _ *ObjectMeta) *FilterResult

func (s *FilterResult) Code() FilterCode

func (s *FilterResult) Err() error

type Hash ¶

type Hash = hash.Hash

Hash is a type alias of Hash from hash package of neofs-api-go.

type Header ¶

type Header = object.Header

Header is a type alias of Header from object package of neofs-api-go.

type Iterator ¶

type Iterator interface {
	Iterate(FilterPipeline, MetaHandler) error
}

Iterator is an interface of the iterator over local object storage.

type ListItem ¶

type ListItem struct {
	ObjectMeta
}

ListItem is an ObjectMeta wrapper.

func ListItems(it Iterator, f FilterPipeline) ([]ListItem, error)

type Localstore ¶

type Localstore interface {
	Put(context.Context, *Object) error
	Get(Address) (*Object, error)
	Del(Address) error
	Meta(Address) (*ObjectMeta, error)
	Iterator
	Has(Address) (bool, error)
	ObjectsCount() (uint64, error)

	object.PositionReader
	Size() int64
}

Localstore is an interface of local object storage.

func New(p Params) (Localstore, error)

type MetaHandler ¶

type MetaHandler func(*ObjectMeta) bool

MetaHandler is a function that handles ObjectMeta.

type Object ¶

type Object = object.Object

Object is a type alias of Object from object package of neofs-api-go.

type ObjectID ¶

type ObjectID = refs.ObjectID

ObjectID is a type alias of ObjectID from refs package of neofs-api-go.

type ObjectMeta ¶

type ObjectMeta struct {
	Object               *object.Object `protobuf:"bytes,1,opt,name=Object,proto3" json:"Object,omitempty"`
	PayloadHash          Hash           `protobuf:"bytes,2,opt,name=PayloadHash,proto3,customtype=Hash" json:"PayloadHash"`
	PayloadSize          uint64         `protobuf:"varint,3,opt,name=PayloadSize,proto3" json:"PayloadSize,omitempty"`
	StoreEpoch           uint64         `protobuf:"varint,4,opt,name=StoreEpoch,proto3" json:"StoreEpoch,omitempty"`
	XXX_NoUnkeyedLiteral struct{}       `json:"-"`
	XXX_unrecognized     []byte         `json:"-"`
	XXX_sizecache        int32          `json:"-"`
}

func (*ObjectMeta) Descriptor() ([]byte, []int)

func (m *ObjectMeta) GetObject() *object.Object

func (m *ObjectMeta) GetPayloadSize() uint64

func (m *ObjectMeta) GetStoreEpoch() uint64

func (m *ObjectMeta) Marshal() (dAtA []byte, err error)

func (m *ObjectMeta) MarshalTo(dAtA []byte) (int, error)

func (m *ObjectMeta) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ObjectMeta) ProtoMessage()

func (m *ObjectMeta) Reset()

func (m *ObjectMeta) Size() (n int)

func (m *ObjectMeta) String() string

func (m *ObjectMeta) Unmarshal(dAtA []byte) error

func (m *ObjectMeta) XXX_DiscardUnknown()

func (m *ObjectMeta) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (m *ObjectMeta) XXX_Merge(src proto.Message)

func (m *ObjectMeta) XXX_Size() int

func (m *ObjectMeta) XXX_Unmarshal(b []byte) error

type Params ¶

type Params struct {
	BlobBucket bucket.Bucket
	MetaBucket bucket.Bucket
	Logger     *zap.Logger
	Collector  metrics2.Collector
}

Params groups the parameters of local object storage constructor.

type PriorityFlag ¶

type PriorityFlag int

PriorityFlag is an enumeration of priority flags.

const (
	// PriorityValue is a PriorityFlag of the sub-filter registration with GetPriority() value.
	PriorityValue PriorityFlag = iota

	// PriorityMax is a PriorityFlag of the sub-filter registration with maximum priority.
	PriorityMax

	// PriorityMin is a PriorityFlag of the sub-filter registration with minimum priority.
	PriorityMin
)

type SGID ¶

type SGID = refs.ObjectID

SGID is a type alias of SGID from refs package of neofs-api-go.

type SubFilterParams ¶

type SubFilterParams struct {
	PriorityFlag
	FilterPipeline
	OnIgnore FilterCode
	OnPass   FilterCode
	OnFail   FilterCode
}

SubFilterParams groups the parameters of sub-filter registration.