frostfs-sdk-go/object/tombstone.go
Evgenii Stratonikov 84888854ab [#322] *: Go fmt -s
go1.19 rewrites comments to proper render them in docs.

Signed-off-by: Evgenii Stratonikov <evgeniy@nspcc.ru>
2022-08-24 18:58:59 +03:00

122 lines
2.9 KiB
Go

package object
import (
"github.com/nspcc-dev/neofs-api-go/v2/refs"
"github.com/nspcc-dev/neofs-api-go/v2/tombstone"
oid "github.com/nspcc-dev/neofs-sdk-go/object/id"
)
// Tombstone represents v2-compatible tombstone structure.
type Tombstone tombstone.Tombstone
// NewTombstoneFromV2 wraps v2 Tombstone message to Tombstone.
//
// Nil tombstone.Tombstone converts to nil.
func NewTombstoneFromV2(tV2 *tombstone.Tombstone) *Tombstone {
return (*Tombstone)(tV2)
}
// NewTombstone creates and initializes blank Tombstone.
//
// Defaults:
// - exp: 0;
// - splitID: nil;
// - members: nil.
func NewTombstone() *Tombstone {
return NewTombstoneFromV2(new(tombstone.Tombstone))
}
// ToV2 converts Tombstone to v2 Tombstone message.
//
// Nil Tombstone converts to nil.
func (t *Tombstone) ToV2() *tombstone.Tombstone {
return (*tombstone.Tombstone)(t)
}
// ExpirationEpoch return number of tombstone expiration epoch.
func (t *Tombstone) ExpirationEpoch() uint64 {
return (*tombstone.Tombstone)(t).GetExpirationEpoch()
}
// SetExpirationEpoch sets number of tombstone expiration epoch.
func (t *Tombstone) SetExpirationEpoch(v uint64) {
(*tombstone.Tombstone)(t).SetExpirationEpoch(v)
}
// SplitID returns identifier of object split hierarchy.
func (t *Tombstone) SplitID() *SplitID {
return NewSplitIDFromV2(
(*tombstone.Tombstone)(t).GetSplitID())
}
// SetSplitID sets identifier of object split hierarchy.
func (t *Tombstone) SetSplitID(v *SplitID) {
(*tombstone.Tombstone)(t).SetSplitID(v.ToV2())
}
// Members returns list of objects to be deleted.
func (t *Tombstone) Members() []oid.ID {
v2 := (*tombstone.Tombstone)(t)
msV2 := v2.GetMembers()
if msV2 == nil {
return nil
}
var (
ms = make([]oid.ID, len(msV2))
id oid.ID
)
for i := range msV2 {
_ = id.ReadFromV2(msV2[i])
ms[i] = id
}
return ms
}
// SetMembers sets list of objects to be deleted.
func (t *Tombstone) SetMembers(v []oid.ID) {
var ms []refs.ObjectID
if v != nil {
ms = (*tombstone.Tombstone)(t).
GetMembers()
if ln := len(v); cap(ms) >= ln {
ms = ms[:0]
} else {
ms = make([]refs.ObjectID, 0, ln)
}
var idV2 refs.ObjectID
for i := range v {
v[i].WriteToV2(&idV2)
ms = append(ms, idV2)
}
}
(*tombstone.Tombstone)(t).SetMembers(ms)
}
// Marshal marshals Tombstone into a protobuf binary form.
func (t *Tombstone) Marshal() ([]byte, error) {
return (*tombstone.Tombstone)(t).StableMarshal(nil), nil
}
// Unmarshal unmarshals protobuf binary representation of Tombstone.
func (t *Tombstone) Unmarshal(data []byte) error {
return (*tombstone.Tombstone)(t).Unmarshal(data)
}
// MarshalJSON encodes Tombstone to protobuf JSON format.
func (t *Tombstone) MarshalJSON() ([]byte, error) {
return (*tombstone.Tombstone)(t).MarshalJSON()
}
// UnmarshalJSON decodes Tombstone from protobuf JSON format.
func (t *Tombstone) UnmarshalJSON(data []byte) error {
return (*tombstone.Tombstone)(t).UnmarshalJSON(data)
}