kubernetes.v0: gopkg.in/kubernetes/kubernetes.v0/pkg/api/resource Index | Examples | Files

package resource

import "gopkg.in/kubernetes/kubernetes.v0/pkg/api/resource"

Index

Examples

Package Files

quantity.go suffix.go

Constants

const (
    DecimalExponent = Format("DecimalExponent") // e.g., 12e6
    BinarySI        = Format("BinarySI")        // e.g., 12Mi (12 * 2^20)
    DecimalSI       = Format("DecimalSI")       // e.g., 12M  (12 * 10^6)
)

Variables

var (

    // Errors that could happen while parsing a string.
    ErrFormatWrong = errors.New("quantities must match the regular expression '" + splitREString + "'")
    ErrNumeric     = errors.New("unable to parse numeric part of quantity")
    ErrSuffix      = errors.New("unable to parse quantity's suffix")

    // The maximum value we can represent milli-units for.
    // Compare with the return value of Quantity.Value() to
    // see if it's safe to use Quantity.MilliValue().
    MaxMilliValue = int64(((1 << 63) - 1) / 1000)
)

func NewQuantityFlagValue Uses

func NewQuantityFlagValue(q *Quantity) flag.Value

NewQuantityFlagValue returns an object that can be used to back a flag, pointing at the given Quantity variable.

type Format Uses

type Format string

Format lists the three possible formattings of a quantity.

Code:

memorySize := resource.NewQuantity(5*1024*1024*1024, resource.BinarySI)
fmt.Printf("memorySize = %v\n", memorySize)

diskSize := resource.NewQuantity(5*1000*1000*1000, resource.DecimalSI)
fmt.Printf("diskSize = %v\n", diskSize)

cores := resource.NewMilliQuantity(5300, resource.DecimalSI)
fmt.Printf("cores = %v\n", cores)

Output:

memorySize = 5Gi
diskSize = 5G
cores = 5300m

type Quantity Uses

type Quantity struct {
    // Amount is public, so you can manipulate it if the accessor
    // functions are not sufficient.
    Amount *inf.Dec

    // Change Format at will. See the comment for Canonicalize for
    // more details.
    Format
}

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and Int64() accessors.

The serialization format is:

<quantity> ::= <signedNumber><suffix>

(Note that <suffix> may be empty, from the "" case in <decimalSI>.)

<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei

(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

<decimalSI> ::= m | "" | k | M | G | T | P | E

(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

<decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber>

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

a. No precision is lost
b. No fractional digits will be emitted
c. The exponent (or suffix) is as large as possible.

The sign will be omitted unless the number is negative.

Examples:

1.5 will be serialized as "1500m"
1.5Gi will be serialized as "1536Mi"

NOTE: We reserve the right to amend this canonical format, perhaps to

allow 1.5 to be canonical.

TODO: Remove above disclaimer after all bikeshedding about format is over,

or after March 2015.

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

func MustParse Uses

func MustParse(str string) Quantity

MustParse turns the given string into a quantity or panics; for tests or others cases where you know the string is valid.

Code:

memorySize := resource.MustParse("5Gi")
fmt.Printf("memorySize = %v (%v)\n", memorySize.Value(), memorySize.Format)

diskSize := resource.MustParse("5G")
fmt.Printf("diskSize = %v (%v)\n", diskSize.Value(), diskSize.Format)

cores := resource.MustParse("5300m")
fmt.Printf("milliCores = %v (%v)\n", cores.MilliValue(), cores.Format)

cores2 := resource.MustParse("5.4")
fmt.Printf("milliCores = %v (%v)\n", cores2.MilliValue(), cores2.Format)

Output:

memorySize = 5368709120 (BinarySI)
diskSize = 5000000000 (DecimalSI)
milliCores = 5300 (DecimalSI)
milliCores = 5400 (DecimalSI)

func NewMilliQuantity Uses

func NewMilliQuantity(value int64, format Format) *Quantity

NewMilliQuantity returns a new Quantity representing the given value * 1/1000 in the given format. Note that BinarySI formatting will round fractional values, and will be changed to DecimalSI for values x where (-1 < x < 1) && (x != 0).

func NewQuantity Uses

func NewQuantity(value int64, format Format) *Quantity

NewQuantity returns a new Quantity representing the given value in the given format.

func ParseQuantity Uses

func ParseQuantity(str string) (*Quantity, error)

ParseQuantity turns str into a Quantity, or returns an error.

func QuantityFlag Uses

func QuantityFlag(flagName, defaultValue, description string) *Quantity

QuantityFlag is a helper that makes a quantity flag (using standard flag package). Will panic if defaultValue is not a valid quantity.

func (*Quantity) Canonicalize Uses

func (q *Quantity) Canonicalize() (string, suffix)

Canonicalize returns the canonical form of q and its suffix (see comment on Quantity).

Note about BinarySI: * If q.Format is set to BinarySI and q.Amount represents a non-zero value between

-1 and +1, it will be emitted as if q.Format were DecimalSI.

* Otherwise, if q.Format is set to BinarySI, frational parts of q.Amount will be

rounded up. (1.1i becomes 2i.)

func (*Quantity) Copy Uses

func (q *Quantity) Copy() *Quantity

Copy is a convenience function that makes a deep copy for you. Non-deep copies of quantities share pointers and you will regret that.

func (Quantity) MarshalJSON Uses

func (q Quantity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface.

func (*Quantity) MilliValue Uses

func (q *Quantity) MilliValue() int64

MilliValue returns the value of q * 1000; this could overflow an int64; if that's a concern, call Value() first to verify the number is small enough.

func (*Quantity) Set Uses

func (q *Quantity) Set(value int64)

Set sets q's value to be value.

func (*Quantity) SetMilli Uses

func (q *Quantity) SetMilli(value int64)

SetMilli sets q's value to be value * 1/1000.

func (*Quantity) String Uses

func (q *Quantity) String() string

String formats the Quantity as a string.

func (*Quantity) UnmarshalJSON Uses

func (q *Quantity) UnmarshalJSON(value []byte) error

UnmarshalJSON implements the json.Unmarshaller interface.

func (*Quantity) Value Uses

func (q *Quantity) Value() int64

Value returns the value of q; any fractional part will be lost.

Package resource imports 8 packages (graph). Updated 2016-07-25. Refresh now. Tools for package owners.