Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AddressWithType ¶ added in v0.36.0
AddressWithType groups object address with its NeoFS object type.
type ContentMeta ¶ added in v0.36.0
type ContentMeta struct {
// contains filtered or unexported fields
}
ContentMeta describes NeoFS meta information that brings object's payload if the object is one of:
- object.TypeTombstone;
- object.TypeStorageGroup;
- object.TypeLock.
func (ContentMeta) Objects ¶ added in v0.36.0
func (i ContentMeta) Objects() []oid.ID
Objects returns objects that the original object's payload affects:
- inhumed objects, if the original object is a Tombstone;
- locked objects, if the original object is a Lock;
- members of a storage group, if the original object is a Storage group;
- nil, if the original object is a Regular object.
func (ContentMeta) Type ¶ added in v0.36.0
func (i ContentMeta) Type() object.Type
Type returns object's type.
type DeleteHandler ¶ added in v0.12.0
type DeleteHandler interface { // DeleteObjects places objects to a removal queue. // // Returns apistatus.LockNonRegularObject if at least one object // is locked. DeleteObjects(oid.Address, ...oid.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 an 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, unprepared bool) error
Validate validates object format.
Does not validate payload checksum and content. If unprepared is true, only fields set by user are validated.
Returns nil error if the object has valid structure.
func (*FormatValidator) ValidateContent ¶ added in v0.12.0
func (v *FormatValidator) ValidateContent(o *object.Object) (ContentMeta, error)
ValidateContent validates payload content according to the object type.
type FormatValidatorOption ¶ added in v0.12.0
type FormatValidatorOption func(*cfg)
FormatValidatorOption represents a FormatValidator constructor option.
func WithLockSource ¶ added in v0.38.0
func WithLockSource(e LockSource) FormatValidatorOption
WithLockSource return option to set a Locked objects source.
func WithNetState ¶ added in v0.16.0
func WithNetState(netState netmap.State) FormatValidatorOption
WithNetState returns options to set the network state interface.
type LockSource ¶ added in v0.38.0
type LockSource interface { // IsLocked must clarify object's lock status. IsLocked(address oid.Address) (bool, error) }
LockSource is a source of lock relations between the objects.
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.