frostfs-sdk-go/object/lock.go
Airat Arifullin 6281a25556
All checks were successful
/ DCO (pull_request) Successful in 1m17s
/ Lint (pull_request) Successful in 2m7s
/ Tests (1.19) (pull_request) Successful in 5m56s
/ Tests (1.20) (pull_request) Successful in 6m37s
[#100] types: Make sdk types as protobuf wrappers
Signed-off-by: Airat Arifullin a.arifullin@yadro.com
2023-07-12 19:08:37 +03:00

91 lines
2.2 KiB
Go

package object
import (
v2lock "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/lock/grpc"
refsgrpc "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/refs/grpc"
oid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/id"
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/util/slices"
)
// Lock represents record with locked objects. It is compatible with
// FrostFS API V2 protocol.
//
// Lock instance can be written to the Object, see WriteLock/ReadLock.
type Lock struct {
lock *v2lock.Lock
}
func NewLock() *Lock {
return &Lock{
lock: &v2lock.Lock{},
}
}
// WriteLock writes Lock to the Object, and sets its type to TypeLock.
// The object must not be nil.
//
// See also ReadLock.
func WriteLock(obj *Object, l Lock) {
obj.SetType(TypeLock)
obj.SetPayload(l.Marshal())
}
// ReadLock reads Lock from the Object. The lock must not be nil.
// Returns an error describing incorrect format. Makes sense only
// if object has TypeLock type.
//
// See also WriteLock.
func ReadLock(l *Lock, obj *Object) error {
return l.Unmarshal(obj.Payload())
}
// NumberOfMembers returns number of members in lock list.
func (x Lock) NumberOfMembers() int {
return x.lock.NumberOfMembers()
}
// ReadMembers reads list of locked members.
//
// Buffer length must not be less than NumberOfMembers.
func (x Lock) ReadMembers(buf []oid.ID) {
var i int
x.lock.IterateMembers(func(idV2 *refsgrpc.ObjectID) {
_ = buf[i].ReadFromV2(idV2)
i++
})
}
// WriteMembers writes list of locked members.
func (x *Lock) WriteMembers(ids []oid.ID) {
var members []*refsgrpc.ObjectID
if ids != nil {
members = slices.MakePreallocPointerSlice[refsgrpc.ObjectID](len(ids))
for i := range ids {
ids[i].WriteToV2(members[i])
}
}
if x.lock == nil {
x.lock = new(v2lock.Lock)
}
x.lock.SetMembers(members)
}
func (x *Lock) ToV2() *v2lock.Lock {
return x.lock
}
// Marshal encodes the Lock into a FrostFS protocol binary format.
func (x Lock) Marshal() []byte {
return x.lock.StableMarshal(nil)
}
// Unmarshal decodes the Lock from its FrostFS protocol binary representation.
func (x *Lock) Unmarshal(data []byte) error {
if x.lock == nil {
x.lock = new(v2lock.Lock)
}
return x.lock.Unmarshal(data)
}