common

Documentation

Index

• func InvalidRequest(msg string) error
• type Balance
  • func ToBalance(tok float64) Balance
  • func (b Balance) String() string
  • func (b Balance) ToToken() float64
• type Error
  • func NewError(code string, msg string) *Error
  • func (err *Error) Error() string
• type Key
• type Size
  • func (s Size) String() string
• type Timestamp
  • func Now() Timestamp
  • func (t Timestamp) ToTime() time.Time
  • func (t Timestamp) Within(seconds Timestamp) bool
• type WhoPays
  • func (wp *WhoPays) Parse(val string) (err error)
  • func (wp WhoPays) String() string
  • func (wp WhoPays) Validate() (err error)

Functions

func InvalidRequest

func InvalidRequest(msg string) error

InvalidRequest - create error messages that are needed when validating request input

Types

type Balance

type Balance int64

Balance represents an amount of tokens.

func ToBalance

func ToBalance(tok float64) Balance

ToBalance converts ZCN tokens to Balance.

func (Balance) String

func (b Balance) String() string

String implements fmt.Stringer interface.

func (Balance) ToToken

func (b Balance) ToToken() float64

ToToken converts the Balance to ZCN tokens.

type Error

type Error struct {
	Code string `json:"code,omitempty"`
	Msg  string `json:"msg"`
}

Error type for a new application error

func NewError

func NewError(code string, msg string) *Error

NewError - create a new error

func (*Error) Error

func (err *Error) Error() string

type Key

type Key string

A Key represents an identifier. It can be a pool ID, client ID, smart contract address, etc.

type Size

type Size int64

A Size represents a size in bytes.

func (Size) String

func (s Size) String() string

String implements fmt.Stringer interface

type Timestamp

type Timestamp int64

Timestamp represents Unix time (e.g. in seconds)

func Now

func Now() Timestamp

Now - current datetime

func (Timestamp) ToTime

func (t Timestamp) ToTime() time.Time

ToTime converts the Timestamp to standard time.Time

func (Timestamp) Within

func (t Timestamp) Within(seconds Timestamp) bool

Within ensures a given timestamp is within certain number of seconds

type WhoPays

type WhoPays int

WhoPays for file downloading.

const (
	WhoPays3rdParty WhoPays = iota // 0, 3rd party user pays
	WhoPaysOwner                   // 1, file owner pays
)

possible variants

func (*WhoPays) Parse

func (wp *WhoPays) Parse(val string) (err error)

Parse given string and set the WhoPays by it. Or return parsing error. The given string should be as result of the String method (case insensitive).

func (WhoPays) String

func (wp WhoPays) String() string

String implements fmt.Stringer interface.

func (WhoPays) Validate

func (wp WhoPays) Validate() (err error)

Validate the WhoPays value.