common

Documentation

Index

• Variables
• func AutoFormatBalance(b Balance) string
• func AutoFormatStatic(amount int64) string
• func FormatBalance(b Balance, unit BalanceUnit) string
• func FormatStatic(amount int64, unit string) string
• func ParseBalanceStatic(str string) (int64, error)
• func ParseTime(now time.Time, input string) (*time.Time, error)
• type Balance
  • func ParseBalance(str string) (Balance, error)
  • func ToBalance(token float64) Balance
  • func (b Balance) AutoFormat() string
  • func (b Balance) Format(unit BalanceUnit) string
  • func (b Balance) String() string
  • func (b Balance) ToToken() float64
• type BalanceUnit
  • func (unit *BalanceUnit) Parse(s string) error
  • func (unit BalanceUnit) String() 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)

Variables

var ErrInvalidTime = errors.New("invalid time")

Functions

func AutoFormatBalance

func AutoFormatBalance(b Balance) string

func AutoFormatStatic

func AutoFormatStatic(amount int64) string

func FormatBalance

func FormatBalance(b Balance, unit BalanceUnit) string

func FormatStatic

func FormatStatic(amount int64, unit string) string

func ParseBalanceStatic

func ParseBalanceStatic(str string) (int64, error)

func ParseTime

func ParseTime(now time.Time, input string) (*time.Time, error)

ParseTime parse a time string with 4 formats +1h5m : now (local timezone) + 1h5m +3900 : now (local timezone) +3900s 1647858200 : Unix timestamp 2022-03-21 10:21:38 : parse UTC date string with YYYY-MM-dd HH:mm:ss

Types

type Balance

type Balance int64

Balance represents 0chain native token

func ParseBalance

func ParseBalance(str string) (Balance, error)

func ToBalance

func ToBalance(token float64) Balance

ToBalance converts ZCN tokens to Balance.

func (Balance) AutoFormat

func (b Balance) AutoFormat() string

func (Balance) Format

func (b Balance) Format(unit BalanceUnit) string

func (Balance) String

func (b Balance) String() string

String implements fmt.Stringer interface.

func (Balance) ToToken

func (b Balance) ToToken() float64

type BalanceUnit

type BalanceUnit byte

const (
	SAS BalanceUnit = iota
	UZCN
	MZCN
	ZCN
)

func (*BalanceUnit) Parse

func (unit *BalanceUnit) Parse(s string) error

func (BalanceUnit) String

func (unit BalanceUnit) String() 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 (
	WhoPaysOwner    WhoPays = iota // 0, file owner pays
	WhoPays3rdParty                // 1, 3rd party user 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.