rate

Documentation

Index

• Constants
• type Rate
  • func ParseRate(rateStr string) (Rate, error)
  • func (d Rate) MarshalJSON() ([]byte, error)
  • func (d Rate) MarshalYAML() (interface{}, error)
  • func (d *Rate) Set(s string) error
  • func (d Rate) String() string
  • func (d *Rate) Type() string
  • func (d *Rate) UnmarshalJSON(b []byte) error
  • func (d *Rate) UnmarshalYAML(unmarshal func(interface{}) error) error

Constants

const (
	B  Rate = 1
	KB      = 1024 * B
	MB      = 1024 * KB
	GB      = 1024 * MB
)

Types

type Rate

type Rate int64

Rate wraps int64. It is used to parse the custom rate format from YAML and JSON. This type should not propagate beyond the scope of input/output processing.

func ParseRate

func ParseRate(rateStr string) (Rate, error)

ParseRate parses a string into a int64.

func (Rate) MarshalJSON

func (d Rate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (Rate) MarshalYAML

func (d Rate) MarshalYAML() (interface{}, error)

MarshalYAML implements the yaml.Marshaler interface.

func (*Rate) Set

func (d *Rate) Set(s string) error

Set implements pflag/flag.Value

func (Rate) String

func (d Rate) String() string

String returns the rate with an uppercase unit.

func (*Rate) Type

func (d *Rate) Type() string

Type implements pflag.Value

func (*Rate) UnmarshalJSON

func (d *Rate) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

func (*Rate) UnmarshalYAML

func (d *Rate) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.