object

Documentation

Index

• Variables
• type DeleteHandler
• type FormatValidator
  • func NewFormatValidator(opts ...FormatValidatorOption) *FormatValidator
  • func (v *FormatValidator) Validate(obj *Object) error
  • func (v *FormatValidator) ValidateContent(o *Object) error
• type FormatValidatorOption
  • func WithDeleteHandler(v DeleteHandler) FormatValidatorOption
• type Object
  • func New() *Object
  • func NewFromSDK(obj *object.Object) *Object
  • func NewFromV2(obj *objectV2.Object) *Object
  • func (o *Object) Address() *object.Address
  • func (o *Object) GetParent() *Object
  • func (o *Object) SDK() *object.Object
• type RawObject
  • func NewRaw() *RawObject
  • func NewRawFrom(obj *object.RawObject) *RawObject
  • func NewRawFromObject(obj *Object) *RawObject
  • func NewRawFromV2(obj *objectV2.Object) *RawObject
  • func (o *RawObject) CutPayload() *RawObject
  • func (o *RawObject) Object() *Object
  • func (o *RawObject) SDK() *object.RawObject

Variables

var ErrAlreadyRemoved = errors.New("object already removed")

ErrAlreadyRemoved returned when object has tombstone in graveyard.

var ErrNotFound = errors.New("object not found")

ErrNotFound is a basic "not found" error returned by object read functions.

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.

Types

type DeleteHandler

type DeleteHandler interface {
	DeleteObjects(*object.Address, ...*object.Address)
}

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) 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) 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.

type Object

type Object struct {
	*object.Object
}

Object represents the NeoFS object.

Object inherits object type from NeoFS SDK. It is used to implement some useful methods and functions for convenient processing of an object by a node.

func New

func New() *Object

New constructs blank Object instance.

func NewFromSDK

func NewFromSDK(obj *object.Object) *Object

NewFromSDK constructs Object instance from NeoFS SDK Object.

func NewFromV2

func NewFromV2(obj *objectV2.Object) *Object

NewFromV2 constructs Object instance from v2 Object message.

func (*Object) Address

func (o *Object) Address() *object.Address

Address returns address of the object.

func (*Object) GetParent

func (o *Object) GetParent() *Object

GetParent returns parent object.

func (*Object) SDK

func (o *Object) SDK() *object.Object

SDK returns NeoFS SDK object instance.

type RawObject

type RawObject struct {
	*object.RawObject
}

RawObject represents the raw NeoFS object.

RawObject inherits RawObject type from NeoFS SDK. It is used to implement some useful methods and functions for convenient processing of a raw object by a node.

func NewRaw

func NewRaw() *RawObject

NewRaw constructs blank RawObject instance.

func NewRawFrom

func NewRawFrom(obj *object.RawObject) *RawObject

NewRawFrom constructs RawObject instance from NeoFS SDK RawObject.

func NewRawFromObject

func NewRawFromObject(obj *Object) *RawObject

NewRawFromObject wraps Object instance to RawObject.

func NewRawFromV2

func NewRawFromV2(obj *objectV2.Object) *RawObject

NewRawFromV2 constructs RawObject instance from v2 Object message.

func (*RawObject) CutPayload

func (o *RawObject) CutPayload() *RawObject

CutPayload returns RawObject w/ empty payload.

Changes of non-payload fields affect source object.

func (*RawObject) Object

func (o *RawObject) Object() *Object

Object converts RawObject to read-only Object instance.

func (*RawObject) SDK

func (o *RawObject) SDK() *object.RawObject

SDK converts RawObject to NeoFS SDK RawObject instance.