object

Documentation

Index

• Variables
• func AddressOf(obj *object.Object) *addressSDK.Address
• type DeleteHandler
• type FormatValidator
  • func NewFormatValidator(opts ...FormatValidatorOption) *FormatValidator
  • func (v *FormatValidator) Validate(obj *object.Object) error
  • func (v *FormatValidator) ValidateContent(o *object.Object) error
• type FormatValidatorOption
  • func WithDeleteHandler(v DeleteHandler) FormatValidatorOption
  • func WithLocker(v Locker) FormatValidatorOption
  • func WithNetState(netState netmap.State) FormatValidatorOption
• type Locker

Variables

var ErrRangeOutOfBounds = errors.New("payload range is out of bounds")

ErrRangeOutOfBounds is a basic error of violation of the boundaries of the payload of an object.

Functions

func AddressOf

func AddressOf(obj *object.Object) *addressSDK.Address

AddressOf returns address of the object.

Types

type DeleteHandler

type DeleteHandler interface {
	// DeleteObjects objects places objects to removal queue.
	//
	// Returns apistatus.LockNonRegularObject if at least one object
	// is locked.
	DeleteObjects(*addressSDK.Address, ...*addressSDK.Address) error
}

DeleteHandler is an interface of delete queue processor.

type FormatValidator

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

FormatValidator represents object format validator.

func NewFormatValidator

func NewFormatValidator(opts ...FormatValidatorOption) *FormatValidator

NewFormatValidator creates, initializes and returns FormatValidator instance.

func (*FormatValidator) Validate

func (v *FormatValidator) Validate(obj *object.Object) error

Validate validates object format.

Does not validate payload checksum and content.

Returns nil error if object has valid structure.

func (*FormatValidator) ValidateContent

func (v *FormatValidator) ValidateContent(o *object.Object) error

ValidateContent validates payload content according to object type.

type FormatValidatorOption

type FormatValidatorOption func(*cfg)

FormatValidatorOption represents FormatValidator constructor option.

func WithDeleteHandler

func WithDeleteHandler(v DeleteHandler) FormatValidatorOption

WithDeleteHandler returns option to set delete queue processor.

func WithLocker

func WithLocker(v Locker) FormatValidatorOption

WithLocker returns option to set object lock storage.

func WithNetState

func WithNetState(netState netmap.State) FormatValidatorOption

WithNetState returns options to set network state interface.

type Locker

type Locker interface {
	// Lock list of objects as locked by locker in the specified container.
	//
	// Returns apistatus.LockNonRegularObject if at least object in locked
	// list is irregular (not type of REGULAR).
	Lock(idCnr cid.ID, locker oid.ID, locked []oid.ID) error
}

Locker is an object lock storage interface.