realloc/frostfs-api-go
1
0
Fork 0
forked from TrueCloudLab/frostfs-api-go
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#302] pkg/owner: Document default values set in

Browse source 
`NewTrust`, `NewPeerToPeerTrust` and `NewGlobalTrust`

Document field values of instance constructed via
`NewTrust`, `NewPeerToPeerTrust` and `NewGlobalTrust`.
Assert the values in corresponding unit test.

Signed-off-by: Pavel Karpy <carpawell@nspcc.ru>
This commit is contained in:
Pavel Karpy 2021-06-08 20:21:03 +03:00 • committed by Alex Vanin
parent 8ab3abab4b
commit 2d7a658059
2 changed files with 61 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
pkg/reputation/trust.go
View file

@ -14,6 +14,10 @@ import (
type Trust reputation.Trust
// NewTrust creates and returns blank Trust.
//
// Defaults:
// - value: 0;
// - PeerID: nil.
func NewTrust() *Trust {
return TrustFromV2(new(reputation.Trust))
}
@ -109,6 +113,10 @@ func (x *Trust) UnmarshalJSON(data []byte) error {
type PeerToPeerTrust reputation.PeerToPeerTrust
// NewPeerToPeerTrust creates and returns blank PeerToPeerTrust.
//
// Defaults:
// - trusting: nil;
// - trust: nil.
func NewPeerToPeerTrust() *PeerToPeerTrust {
return PeerToPeerTrustFromV2(new(reputation.PeerToPeerTrust))
}
@ -193,7 +201,10 @@ type GlobalTrust reputation.GlobalTrust
// NewGlobalTrust creates and returns blank GlobalTrust.
//
// Version is initialized to current library version.
// Defaults:
// - version: pkg.SDKVersion();
// - manager: nil;
// - trust: nil.
func NewGlobalTrust() *GlobalTrust {
gt := GlobalTrustFromV2(new(reputation.GlobalTrust))
gt.SetVersion(pkg.SDKVersion())