3bc25f54d8
Document field values of instance constructed via `New`. Assert the values in corresponding unit test. Signed-off-by: Pavel Karpy <carpawell@nspcc.ru>
157 lines
3.9 KiB
Go
157 lines
3.9 KiB
Go
package storagegroup
|
|
|
|
import (
|
|
"github.com/nspcc-dev/neofs-api-go/pkg"
|
|
"github.com/nspcc-dev/neofs-api-go/pkg/object"
|
|
"github.com/nspcc-dev/neofs-api-go/v2/refs"
|
|
"github.com/nspcc-dev/neofs-api-go/v2/storagegroup"
|
|
)
|
|
|
|
// StorageGroup represents v2-compatible storage group.
|
|
type StorageGroup storagegroup.StorageGroup
|
|
|
|
// NewFromV2 wraps v2 StorageGroup message to StorageGroup.
|
|
//
|
|
// Nil storagegroup.StorageGroup converts to nil.
|
|
func NewFromV2(aV2 *storagegroup.StorageGroup) *StorageGroup {
|
|
return (*StorageGroup)(aV2)
|
|
}
|
|
|
|
// New creates and initializes blank StorageGroup.
|
|
//
|
|
// Defaults:
|
|
// - size: 0;
|
|
// - exp: 0;
|
|
// - members: nil;
|
|
// - hash: nil.
|
|
func New() *StorageGroup {
|
|
return NewFromV2(new(storagegroup.StorageGroup))
|
|
}
|
|
|
|
// ValidationDataSize returns total size of the payloads
|
|
// of objects in the storage group
|
|
func (sg *StorageGroup) ValidationDataSize() uint64 {
|
|
return (*storagegroup.StorageGroup)(sg).
|
|
GetValidationDataSize()
|
|
}
|
|
|
|
// SetValidationDataSize sets total size of the payloads
|
|
// of objects in the storage group.
|
|
func (sg *StorageGroup) SetValidationDataSize(epoch uint64) {
|
|
(*storagegroup.StorageGroup)(sg).
|
|
SetValidationDataSize(epoch)
|
|
}
|
|
|
|
// ValidationDataHash returns homomorphic hash from the
|
|
// concatenation of the payloads of the storage group members.
|
|
func (sg *StorageGroup) ValidationDataHash() *pkg.Checksum {
|
|
return pkg.NewChecksumFromV2(
|
|
(*storagegroup.StorageGroup)(sg).
|
|
GetValidationHash(),
|
|
)
|
|
}
|
|
|
|
// SetValidationDataHash sets homomorphic hash from the
|
|
// concatenation of the payloads of the storage group members.
|
|
func (sg *StorageGroup) SetValidationDataHash(hash *pkg.Checksum) {
|
|
(*storagegroup.StorageGroup)(sg).
|
|
SetValidationHash(hash.ToV2())
|
|
}
|
|
|
|
// ExpirationEpoch returns last NeoFS epoch number
|
|
// of the storage group lifetime.
|
|
func (sg *StorageGroup) ExpirationEpoch() uint64 {
|
|
return (*storagegroup.StorageGroup)(sg).
|
|
GetExpirationEpoch()
|
|
}
|
|
|
|
// SetExpirationEpoch sets last NeoFS epoch number
|
|
// of the storage group lifetime.
|
|
func (sg *StorageGroup) SetExpirationEpoch(epoch uint64) {
|
|
(*storagegroup.StorageGroup)(sg).
|
|
SetExpirationEpoch(epoch)
|
|
}
|
|
|
|
// Members returns strictly ordered list of
|
|
// storage group member objects.
|
|
func (sg *StorageGroup) Members() []*object.ID {
|
|
mV2 := (*storagegroup.StorageGroup)(sg).
|
|
GetMembers()
|
|
|
|
if mV2 == nil {
|
|
return nil
|
|
}
|
|
|
|
m := make([]*object.ID, len(mV2))
|
|
|
|
for i := range mV2 {
|
|
m[i] = object.NewIDFromV2(mV2[i])
|
|
}
|
|
|
|
return m
|
|
}
|
|
|
|
// SetMembers sets strictly ordered list of
|
|
// storage group member objects.
|
|
func (sg *StorageGroup) SetMembers(members []*object.ID) {
|
|
mV2 := (*storagegroup.StorageGroup)(sg).
|
|
GetMembers()
|
|
|
|
if members == nil {
|
|
mV2 = nil
|
|
} else {
|
|
ln := len(members)
|
|
|
|
if cap(mV2) >= ln {
|
|
mV2 = mV2[:0]
|
|
} else {
|
|
mV2 = make([]*refs.ObjectID, 0, ln)
|
|
}
|
|
|
|
for i := 0; i < ln; i++ {
|
|
mV2 = append(mV2, members[i].ToV2())
|
|
}
|
|
}
|
|
|
|
(*storagegroup.StorageGroup)(sg).
|
|
SetMembers(mV2)
|
|
}
|
|
|
|
// ToV2 converts StorageGroup to v2 StorageGroup message.
|
|
//
|
|
// Nil StorageGroup converts to nil.
|
|
func (sg *StorageGroup) ToV2() *storagegroup.StorageGroup {
|
|
return (*storagegroup.StorageGroup)(sg)
|
|
}
|
|
|
|
// Marshal marshals StorageGroup into a protobuf binary form.
|
|
//
|
|
// Buffer is allocated when the argument is empty.
|
|
// Otherwise, the first buffer is used.
|
|
func (sg *StorageGroup) Marshal(b ...[]byte) ([]byte, error) {
|
|
var buf []byte
|
|
if len(b) > 0 {
|
|
buf = b[0]
|
|
}
|
|
|
|
return (*storagegroup.StorageGroup)(sg).
|
|
StableMarshal(buf)
|
|
}
|
|
|
|
// Unmarshal unmarshals protobuf binary representation of StorageGroup.
|
|
func (sg *StorageGroup) Unmarshal(data []byte) error {
|
|
return (*storagegroup.StorageGroup)(sg).
|
|
Unmarshal(data)
|
|
}
|
|
|
|
// MarshalJSON encodes StorageGroup to protobuf JSON format.
|
|
func (sg *StorageGroup) MarshalJSON() ([]byte, error) {
|
|
return (*storagegroup.StorageGroup)(sg).
|
|
MarshalJSON()
|
|
}
|
|
|
|
// UnmarshalJSON decodes StorageGroup from protobuf JSON format.
|
|
func (sg *StorageGroup) UnmarshalJSON(data []byte) error {
|
|
return (*storagegroup.StorageGroup)(sg).
|
|
UnmarshalJSON(data)
|
|
}
|