common

Documentation

Index

• Variables
• func ExitOnErr(cmd *cobra.Command, errFmt string, err error)
• func ParseEpoch(cmd *cobra.Command, flag string) (uint64, bool, error)
• func PrettyPrintJSON(cmd *cobra.Command, m json.Marshaler, entity string)
• func PrettyPrintUnixTime(s string) string
• func PrintChecksum(cmd *cobra.Command, name string, recv func() (checksum.Checksum, bool))
• func PrintVerbose(cmd *cobra.Command, format string, a ...any)
• func ReadBearerToken(cmd *cobra.Command, flagname string) *bearer.Token
• func ReadBinaryOrJSON(cmd *cobra.Command, dst BinaryOrJSON, fPath string) error
• func ReadEACL(cmd *cobra.Command, eaclPath string) *eacl.Table
• type BinaryOrJSON

Variables

var ErrAwaitTimeout = errors.New("await timeout expired")

ErrAwaitTimeout represents the expiration of a polling interval while awaiting a certain condition.

Functions

func ExitOnErr

func ExitOnErr(cmd *cobra.Command, errFmt string, err error)

ExitOnErr prints error and exits with a code depending on the error type

0 if nil
1 if [sdkstatus.ErrServerInternal] or untyped
2 if [sdkstatus.ErrObjectAccessDenied]
3 if [ErrAwaitTimeout]

func ParseEpoch

func ParseEpoch(cmd *cobra.Command, flag string) (uint64, bool, error)

ParseEpoch parses epoch argument. Second return value is true if the specified epoch is relative, and false otherwise.

func PrettyPrintJSON

func PrettyPrintJSON(cmd *cobra.Command, m json.Marshaler, entity string)

PrettyPrintJSON prints m as an indented JSON to the cmd output.

func PrettyPrintUnixTime

func PrettyPrintUnixTime(s string) string

PrettyPrintUnixTime interprets s as unix timestamp and prints it as a date. Is s is invalid, "malformed" is returned.

func PrintChecksum

func PrintChecksum(cmd *cobra.Command, name string, recv func() (checksum.Checksum, bool))

PrintChecksum prints checksum.

func PrintVerbose

func PrintVerbose(cmd *cobra.Command, format string, a ...any)

PrintVerbose prints to the stdout if the commonflags.Verbose flag is on.

func ReadBearerToken

func ReadBearerToken(cmd *cobra.Command, flagname string) *bearer.Token

ReadBearerToken reads bearer token from the path provided in a specified flag.

func ReadBinaryOrJSON

func ReadBinaryOrJSON(cmd *cobra.Command, dst BinaryOrJSON, fPath string) error

ReadBinaryOrJSON reads file data using provided path and decodes BinaryOrJSON from the data.

func ReadEACL

func ReadEACL(cmd *cobra.Command, eaclPath string) *eacl.Table

ReadEACL reads extended ACL table from eaclPath.

Types

type BinaryOrJSON

type BinaryOrJSON interface {
	Unmarshal([]byte) error
	json.Unmarshaler
}

BinaryOrJSON is an interface of entities which provide json.Unmarshaler and NeoFS binary decoder.