byte

import "github.com/sphireinc/mantis/byte"

Index

• Constants
• Variables
• type Bytes
  • func ParseBytes(s string) (Bytes, error)
  • func (b Bytes) Format(s fmt.State, verb rune)
  • func (b Bytes) String() string
• type BytesUnit
  • func (u BytesUnit) Convert(b Bytes) float64
  • func (u BytesUnit) String() string
• type ParseErr
  • func (e *ParseErr) Error() string
  • func (e *ParseErr) String() string

Constants

const (
    // B byte (Unit)
    B   BytesUnit = 1
    // KB Kilobyte (SI) - 1000 bytes
    KB  BytesUnit = 1000
    // MB Megabyte (SI) - 1e6 bytes
    MB  BytesUnit = 1e6
    // GB Gigabyte (SI) - 1e9 bytes
    GB  BytesUnit = 1e9
    // TB Terabyte (SI) - 1e12 bytes
    TB  BytesUnit = 1e12
    // PB Petabyte (SI) - 1e15 bytes
    PB  BytesUnit = 1e15

    // KiB Kibibyte (NIST) - 1024 bytes
    KiB BytesUnit = 1024
    // MiB Mebibyte (NIST) - 2^20 bytes
    MiB = 1024 * KiB
    // GiB Gibibyte (NIST) - 2^30 bytes
    GiB = 1024 * MiB
    // TiB Tebibyte (NIST) - 2^40 bytes
    TiB = 1024 * GiB
    // PiB Pebibyte (NIST) - 2^50 bytes
    PiB = 1024 * TiB
)

Variables

var byteUnitToStr = map[BytesUnit]string{
    B:   "B",
    KB:  "KB",
    KiB: "KiB",
    MB:  "MB",
    MiB: "MiB",
    GB:  "GB",
    GiB: "GiB",
    TB:  "TB",
    TiB: "TiB",
    PB:  "PB",
    PiB: "PiB",
}

var bytesSIUnitThresholds = []struct {
    unit BytesUnit
    less Bytes
}{
    {B, 5e2},
    {KB, 5e5},
    {MB, 5e8},
    {GB, 5e11},
    {TB, 5e14},
    {PB, 0x7FFFFFFFFFFFFFFF},
}

var bytesUnitThresholds = []struct {
    unit BytesUnit
    less Bytes
}{
    {B, 0x400},
    {KiB, Bytes(uint64(MiB) >> 4)},
    {MiB, Bytes(uint64(GiB) >> 4)},
    {GiB, Bytes(uint64(TiB) >> 4)},
    {TiB, Bytes(uint64(PiB) >> 4)},
    {PiB, 0x7FFFFFFFFFFFFFFF},
}

var strToByteUnit = map[string]BytesUnit{
    "":    B,
    "B":   B,
    "KB":  KB,
    "KIB": KiB,
    "MB":  MB,
    "MIB": MiB,
    "GB":  GB,
    "GIB": GiB,
    "TB":  TB,
    "TIB": TiB,
    "PB":  PB,
    "PIB": PiB,
}

type Bytes

Bytes is a formattable byte count

type Bytes int64

func ParseBytes

func ParseBytes(s string) (Bytes, error)

ParseBytes parses the given string with byte units into a Byte count

func (Bytes) Format

func (b Bytes) Format(s fmt.State, verb rune)

Format bytes

func (Bytes) String

func (b Bytes) String() string

type BytesUnit

BytesUnit represents a unit of magnitude for Bytes in either SI (base-10) or NIST (base-2)

type BytesUnit int64

func (BytesUnit) Convert

func (u BytesUnit) Convert(b Bytes) float64

Convert a byte count into the (possibly fractional) count in this unit

func (BytesUnit) String

func (u BytesUnit) String() string

type ParseErr

ParseErr returned invalid strings are parsed

type ParseErr struct {
    Func string
    Str  string
    Err  error
}

func (*ParseErr) Error

func (e *ParseErr) Error() string

func (*ParseErr) String

func (e *ParseErr) String() string

Generated by gomarkdoc