subnet

Documentation

Overview

Package subnet collects functionality related to the FrostFS subnets.

Subnet of a particular FrostFS network consists of a subset of the storage nodes of that network. Subnet of the whole network is called zero. Info type acts as a subnet descriptor. Each subnet is owned by the user who created it. Information about all subnets is stored in the Subnet contract of the FrostFS Sidechain.

Index

• func AssertOwnership(info Info, id user.ID) bool
• func AssertReference(info Info, id subnetid.ID) bool
• type Info
  • func (x Info) ID() subnetid.ID
  • func (x Info) Marshal() []byte
  • func (x Info) Owner() user.ID
  • func (x *Info) SetID(id subnetid.ID)
  • func (x *Info) SetOwner(id user.ID)
  • func (x *Info) Unmarshal(data []byte) error

Functions

func AssertOwnership

func AssertOwnership(info Info, id user.ID) bool

AssertOwnership checks if the given info describes the subnet owned by the given user.

func AssertReference

func AssertReference(info Info, id subnetid.ID) bool

AssertReference checks if the given info describes the subnet referenced by the given id.

Types

type Info

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

Info represents information about FrostFS subnet.

Instances can be created using built-in var declaration.

func (Info) ID

func (x Info) ID() subnetid.ID

ID returns subnet identifier set using SetID.

Zero Info refers to the zero subnet.

func (Info) Marshal

func (x Info) Marshal() []byte

Marshal encodes Info into a binary format of the FrostFS API protocol (Protocol Buffers with direct field order).

See also Unmarshal.

func (Info) Owner

func (x Info) Owner() user.ID

Owner returns subnet owner set using SetOwner.

Zero Info has no owner which is incorrect according to the FrostFS API protocol.

func (*Info) SetID

func (x *Info) SetID(id subnetid.ID)

SetID sets the identifier of the subnet that Info describes.

See also ID.

func (*Info) SetOwner

func (x *Info) SetOwner(id user.ID)

SetOwner sets identifier of the subnet owner.

func (*Info) Unmarshal

func (x *Info) Unmarshal(data []byte) error

Unmarshal decodes binary Info calculated using Marshal. Returns an error describing a format violation.