Documentation
¶
Index ¶
Constants ¶
This section is empty.
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 ¶
Types ¶
type DeleteHandler ¶ added in v0.12.0
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 ¶ added in v0.12.0
type FormatValidator struct {
// contains filtered or unexported fields
}
FormatValidator represents object format validator.
func NewFormatValidator ¶ added in v0.12.0
func NewFormatValidator(opts ...FormatValidatorOption) *FormatValidator
NewFormatValidator creates, initializes and returns FormatValidator instance.
func (*FormatValidator) Validate ¶ added in v0.12.0
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 ¶ added in v0.12.0
func (v *FormatValidator) ValidateContent(o *object.Object) error
ValidateContent validates payload content according to object type.
type FormatValidatorOption ¶ added in v0.12.0
type FormatValidatorOption func(*cfg)
FormatValidatorOption represents FormatValidator constructor option.
func WithDeleteHandler ¶ added in v0.12.0
func WithDeleteHandler(v DeleteHandler) FormatValidatorOption
WithDeleteHandler returns option to set delete queue processor.
func WithLocker ¶ added in v0.28.0
func WithLocker(v Locker) FormatValidatorOption
WithLocker returns option to set object lock storage.
func WithNetState ¶ added in v0.16.0
func WithNetState(netState netmap.State) FormatValidatorOption
WithNetState returns options to set network state interface.
type Locker ¶ added in v0.28.0
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.
Source Files