transformer

Documentation

Index

• type AccessIdentifiers
  • func (a AccessIdentifiers) SelfID() oid.ID
  • func (a *AccessIdentifiers) WithSelfID(v oid.ID) *AccessIdentifiers
• type ObjectTarget
• type TargetInitializer

Types

type AccessIdentifiers

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

AccessIdentifiers groups the result of the writing object operation.

func (AccessIdentifiers) SelfID

func (a AccessIdentifiers) SelfID() oid.ID

SelfID returns identifier of the written object.

func (*AccessIdentifiers) WithSelfID

func (a *AccessIdentifiers) WithSelfID(v oid.ID) *AccessIdentifiers

WithSelfID returns AccessIdentifiers with passed self identifier.

type ObjectTarget

type ObjectTarget interface {
	// WriteHeader writes object header w/ payload part.
	// The payload of the object may be incomplete.
	//
	// Must be called exactly once. Control remains with the caller.
	// Missing a call or re-calling can lead to undefined behavior
	// that depends on the implementation.
	//
	// Must not be called after Close call.
	WriteHeader(*object.Object) error

	// Write writes object payload chunk.
	//
	// Can be called multiple times.
	//
	// Must not be called after Close call.
	io.Writer

	// Close is used to finish object writing.
	//
	// Close must return access identifiers of the object
	// that has been written.
	//
	// Must be called no more than once. Control remains with the caller.
	// Re-calling can lead to undefined behavior
	// that depends on the implementation.
	Close() (*AccessIdentifiers, error)
}

ObjectTarget is an interface of the object writer.

type TargetInitializer

type TargetInitializer func() ObjectTarget

TargetInitializer represents ObjectTarget constructor.