frostfs-api-go/pkg/signature.go
Pavel Karpy b506970636 [#302] pkg/signature: Convert nil Signature to nil message
Document that `Signature.ToV2` method return `nil`
when called on `nil`. Document that `NewSignatureFromV2`
function return `nil` when called on `nil`. Write
corresponding unit tests.

Signed-off-by: Pavel Karpy <carpawell@nspcc.ru>
2021-06-09 17:23:35 +03:00

81 lines
1.9 KiB
Go

package pkg
import (
"github.com/nspcc-dev/neofs-api-go/v2/refs"
)
// Signature represents v2-compatible signature.
type Signature refs.Signature
// NewSignatureFromV2 wraps v2 Signature message to Signature.
//
// Nil refs.Signature converts to nil.
func NewSignatureFromV2(sV2 *refs.Signature) *Signature {
return (*Signature)(sV2)
}
// NewSignature creates and initializes blank Signature.
//
// Works similar as NewSignatureFromV2(new(Signature)).
func NewSignature() *Signature {
return NewSignatureFromV2(new(refs.Signature))
}
// Key sets binary public key.
func (s *Signature) Key() []byte {
return (*refs.Signature)(s).GetKey()
}
// SetKey returns binary public key.
func (s *Signature) SetKey(v []byte) {
(*refs.Signature)(s).SetKey(v)
}
// Sign return signature value.
func (s *Signature) Sign() []byte {
return (*refs.Signature)(s).GetSign()
}
// SetSign sets signature value.
func (s *Signature) SetSign(v []byte) {
(*refs.Signature)(s).SetSign(v)
}
// ToV2 converts Signature to v2 Signature message.
//
// Nil Signature converts to nil.
func (s *Signature) ToV2() *refs.Signature {
return (*refs.Signature)(s)
}
// Marshal marshals Signature into a protobuf binary form.
//
// Buffer is allocated when the argument is empty.
// Otherwise, the first buffer is used.
func (s *Signature) Marshal(b ...[]byte) ([]byte, error) {
var buf []byte
if len(b) > 0 {
buf = b[0]
}
return (*refs.Signature)(s).
StableMarshal(buf)
}
// Unmarshal unmarshals protobuf binary representation of Signature.
func (s *Signature) Unmarshal(data []byte) error {
return (*refs.Signature)(s).
Unmarshal(data)
}
// MarshalJSON encodes Signature to protobuf JSON format.
func (s *Signature) MarshalJSON() ([]byte, error) {
return (*refs.Signature)(s).
MarshalJSON()
}
// UnmarshalJSON decodes Signature from protobuf JSON format.
func (s *Signature) UnmarshalJSON(data []byte) error {
return (*refs.Signature)(s).
UnmarshalJSON(data)
}