container

package
v1.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 7, 2021 License: Apache-2.0 Imports: 11 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	// AttributeName is an attribute key that is commonly used to denote
	// human-friendly name.
	AttributeName = "Name"

	// AttributeTimestamp is an attribute key that is commonly used to denote
	// user-defined local time of container creation in Unix Timestamp format.
	AttributeTimestamp = "Timestamp"
)

Variables

View Source 
var ErrIDMismatch = errors.New("container structure does not match the identifier")

ErrIDMismatch is returned when container structure does not match a specific identifier.

Functions

This section is empty.

Types

type Attribute 

type Attribute container.Attribute

func NewAttribute 

func NewAttribute() *Attribute

func NewAttributeFromV2 

func NewAttributeFromV2(v *container.Attribute) *Attribute

func (*Attribute) Key 

func (a *Attribute) Key() string

func (*Attribute) SetKey 

func (a *Attribute) SetKey(v string)

func (*Attribute) SetValue 

func (a *Attribute) SetValue(v string)

func (*Attribute) ToV2 

func (a *Attribute) ToV2() *container.Attribute

func (*Attribute) Value 

func (a *Attribute) Value() string

type Attributes 

type Attributes []*Attribute

func NewAttributesFromV2 

func NewAttributesFromV2(v []*container.Attribute) Attributes

func (Attributes) ToV2 

func (a Attributes) ToV2() []*container.Attribute

type Container 

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

func New 

func New(opts ...NewOption) *Container

func NewContainerFromV2 

func NewContainerFromV2(c *container.Container) *Container

NewVerifiedFromV2 constructs Container from NeoFS API V2 Container message.

Does not perform if message meets NeoFS API V2 specification. To do this use NewVerifiedFromV2 constructor.

func NewVerifiedFromV2 added in v1.21.2 

func NewVerifiedFromV2(cnrV2 *container.Container) (*Container, error)

NewVerifiedFromV2 constructs Container from NeoFS API V2 Container message. Returns error if message does not meet NeoFS API V2 specification.

Additionally checks if message carries supported version.

func (*Container) Attributes 

func (c *Container) Attributes() Attributes

func (*Container) BasicACL 

func (c *Container) BasicACL() uint32

func (*Container) Marshal 

func (c *Container) Marshal(b ...[]byte) ([]byte, error)

Marshal marshals Container into a protobuf binary form.

Buffer is allocated when the argument is empty. Otherwise, the first buffer is used.

func (*Container) MarshalJSON 

func (c *Container) MarshalJSON() ([]byte, error)

MarshalJSON encodes Container to protobuf JSON format.

func (*Container) Nonce deprecated 

func (c *Container) Nonce() []byte

Nonce returns container nonce in a binary format.

Returns nil if container nonce is not a valid UUID.

Deprecated: use NonceUUID instead.

func (*Container) NonceUUID added in v1.21.2 

func (c *Container) NonceUUID() (uuid.UUID, error)

Returns container nonce in UUID format.

Returns error if container nonce is not a valid UUID.

func (*Container) OwnerID 

func (c *Container) OwnerID() *owner.ID

func (*Container) PlacementPolicy 

func (c *Container) PlacementPolicy() *netmap.PlacementPolicy

func (*Container) SetAttributes 

func (c *Container) SetAttributes(v Attributes)

func (*Container) SetBasicACL 

func (c *Container) SetBasicACL(v uint32)

func (*Container) SetNonce deprecated 

func (c *Container) SetNonce(v []byte)

SetNonce sets container nonce in a binary format.

If slice length is less than UUID size, than value is padded with a sequence of zeros. If slice length is more than UUID size, than value is cut.

Deprecated: use SetNonceUUID instead.

func (*Container) SetNonceUUID added in v1.21.2 

func (c *Container) SetNonceUUID(v uuid.UUID)

SetNonceUUID sets container nonce as UUID.

func (*Container) SetOwnerID 

func (c *Container) SetOwnerID(v *owner.ID)

func (*Container) SetPlacementPolicy 

func (c *Container) SetPlacementPolicy(v *netmap.PlacementPolicy)

func (*Container) SetVersion 

func (c *Container) SetVersion(v *pkg.Version)

func (*Container) ToV2 

func (c *Container) ToV2() *container.Container

func (*Container) Unmarshal 

func (c *Container) Unmarshal(data []byte) error

Unmarshal unmarshals protobuf binary representation of Container.

func (*Container) UnmarshalJSON 

func (c *Container) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes Container from protobuf JSON format.

func (*Container) Version 

func (c *Container) Version() *pkg.Version

type ID 

type ID refs.ContainerID

ID represents v2-compatible container identifier.

func CalculateID 

func CalculateID(c *Container) *ID

CalculateID calculates container identifier based on its structure.

func NewID 

func NewID() *ID

NewID creates and initializes blank ID.

Works similar to NewIDFromV2(new(ContainerID)).

func NewIDFromV2 

func NewIDFromV2(idV2 *refs.ContainerID) *ID

NewIDFromV2 wraps v2 ContainerID message to ID.

func (*ID) Equal 

func (id *ID) Equal(id2 *ID) bool

Equal returns true if identifiers are identical.

func (*ID) Marshal 

func (id *ID) Marshal(b ...[]byte) ([]byte, error)

Marshal marshals ID into a protobuf binary form.

Buffer is allocated when the argument is empty. Otherwise, the first buffer is used.

func (*ID) MarshalJSON 

func (id *ID) MarshalJSON() ([]byte, error)

MarshalJSON encodes ID to protobuf JSON format.

func (*ID) Parse 

func (id *ID) Parse(s string) error

Parse converts base58 string representation into ID.

func (*ID) SetSHA256 

func (id *ID) SetSHA256(v [sha256.Size]byte)

SetSHA256 sets container identifier value to SHA256 checksum.

func (*ID) String 

func (id *ID) String() string

String returns base58 string representation of ID.

func (*ID) ToV2 

func (id *ID) ToV2() *refs.ContainerID

ToV2 returns the v2 container ID message.

func (*ID) Unmarshal 

func (id *ID) Unmarshal(data []byte) error

Unmarshal unmarshals protobuf binary representation of ID.

func (*ID) UnmarshalJSON 

func (id *ID) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes ID from protobuf JSON format.

type NewOption 

type NewOption interface {
	// contains filtered or unexported methods
}

func WithAttribute 

func WithAttribute(key, value string) NewOption

func WithCustomBasicACL 

func WithCustomBasicACL(acl uint32) NewOption

func WithNEO3Wallet 

func WithNEO3Wallet(w *owner.NEO3Wallet) NewOption

func WithNonce 

func WithNonce(nonce uuid.UUID) NewOption

func WithOwnerID 

func WithOwnerID(id *owner.ID) NewOption

func WithPolicy 

func WithPolicy(policy *netmap.PlacementPolicy) NewOption

func WithPublicBasicACL 

func WithPublicBasicACL() NewOption

func WithReadOnlyBasicACL 

func WithReadOnlyBasicACL() NewOption

type UsedSpaceAnnouncement added in v1.23.0 

type UsedSpaceAnnouncement container.UsedSpaceAnnouncement

UsedSpaceAnnouncement is an announcement message used by storage nodes to estimate actual container sizes.

func NewAnnouncement added in v1.23.0 

func NewAnnouncement() *UsedSpaceAnnouncement

NewAnnouncement initialize empty UsedSpaceAnnouncement message.

func NewAnnouncementFromV2 added in v1.23.0 

func NewAnnouncementFromV2(v *container.UsedSpaceAnnouncement) *UsedSpaceAnnouncement

NewAnnouncementFromV2 wraps protocol dependent version of UsedSpaceAnnouncement message.

func (*UsedSpaceAnnouncement) ContainerID added in v1.23.0 

func (a *UsedSpaceAnnouncement) ContainerID() *ID

ContainerID of the announcement.

func (*UsedSpaceAnnouncement) Epoch added in v1.23.0 

func (a *UsedSpaceAnnouncement) Epoch() uint64

Epoch of the announcement.

func (*UsedSpaceAnnouncement) Marshal added in v1.23.0 

func (a *UsedSpaceAnnouncement) Marshal(b ...[]byte) ([]byte, error)

Marshal marshals UsedSpaceAnnouncement into a protobuf binary form.

Buffer is allocated when the argument is empty. Otherwise, the first buffer is used.

func (*UsedSpaceAnnouncement) SetContainerID added in v1.23.0 

func (a *UsedSpaceAnnouncement) SetContainerID(cid *ID)

SetContainerID sets announcement container value.

func (*UsedSpaceAnnouncement) SetEpoch added in v1.23.0 

func (a *UsedSpaceAnnouncement) SetEpoch(epoch uint64)

SetEpoch sets announcement epoch value.

func (*UsedSpaceAnnouncement) SetUsedSpace added in v1.23.0 

func (a *UsedSpaceAnnouncement) SetUsedSpace(value uint64)

SetUsedSpace sets used space value by specified container.

func (*UsedSpaceAnnouncement) ToV2 added in v1.23.0 

func (a *UsedSpaceAnnouncement) ToV2() *container.UsedSpaceAnnouncement

ToV2 returns protocol dependent version of UsedSpaceAnnouncement message.

func (*UsedSpaceAnnouncement) Unmarshal added in v1.23.0 

func (a *UsedSpaceAnnouncement) Unmarshal(data []byte) error

Unmarshal unmarshals protobuf binary representation of UsedSpaceAnnouncement.

func (*UsedSpaceAnnouncement) UsedSpace added in v1.23.0 

func (a *UsedSpaceAnnouncement) UsedSpace() uint64

UsedSpace in container.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.