headers

Documentation

Index

• Constants
• func SupportedType(t Type) bool
• type Header
  • func NewUserHeader(key, val string) *Header
• type Type
• type UserHeader
  • func (u UserHeader) Key() string
  • func (u *UserHeader) SetKey(key string)
  • func (u *UserHeader) SetValue(val string)
  • func (u UserHeader) Value() string

Constants

const (

	// TypeLink is the type of object reference header.
	TypeLink

	// TypeUser is the of user key-value string header.
	TypeUser

	// TypeTransform is the type of transformation mark header.
	TypeTransform

	// TypeTombstone is the type of tombstone mark header.
	TypeTombstone

	// TypeSessionToken is the type of session token header.
	TypeSessionToken

	// TypeHomomorphicHash is the type of homomorphic hash header.
	TypeHomomorphicHash

	// TypePayloadChecksum is the type of payload checksum header.
	TypePayloadChecksum

	// TypeIntegrity is the type of integrity header.
	TypeIntegrity

	// TypeStorageGroup is the type of storage group header.
	TypeStorageGroup

	// TypePublicKey is the type of public key header.
	TypePublicKey
)

Functions

func SupportedType

func SupportedType(t Type) bool

SupportedType returns true if Type is the known type of extended header. Each supported type has named constant.

Types

type Header

type Header = object.ExtendedHeader

Header represents object extended header.

It is a type alias of github.com/nspcc-dev/neofs-node/pkg/core/object.ExtendedHeader.

func NewUserHeader

func NewUserHeader(key, val string) *Header

NewUserHeader creates, initialized and returns the user extended header.

type Type

type Type = object.ExtendedHeaderType

Type represents extended header type.

It is a type alias of github.com/nspcc-dev/neofs-node/pkg/core/object.ExtendedHeaderType.

type UserHeader

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

UserHeader is a value of object extended header that carries user string key-value pairs.

All user headers must be type of TypeUser. All user header must have UserHeader pointer value.

func (UserHeader) Key

func (u UserHeader) Key() string

Key returns the user header key.

func (*UserHeader) SetKey

func (u *UserHeader) SetKey(key string)

SetKey sets the user header key.

func (*UserHeader) SetValue

func (u *UserHeader) SetValue(val string)

SetValue sets the user header value.

func (UserHeader) Value

func (u UserHeader) Value() string

Value returns the user header value.