size

README

size

simple conversion between size and string

install

go get -u github.com/dstgo/size@latest

units

type Unit = int

const (
	B Unit = 1 << (iota * 10)
	KB
	MB
	GB
	TB
	PB
	EB
)

usage

package main

import (
	"fmt"
	"github.com/dstgo/size"
)

func main() {
	s1 := size.NewInt(1, size.KB)
	fmt.Println(s1)
	s2 := s1.To(size.MB)
	fmt.Println(s2)

	s3, ok := size.Lookup("1.2MB")
	if !ok {
		panic("failed to lookup")
	}
	fmt.Println(s3)
	lookupTo, ok := size.LookupTo("1.2MB", size.KB)
	if !ok {
		panic("failed to lookup")
	}
	fmt.Println(lookupTo)
}

output

1KB
0.001MB 
1.2MB   
1228.8KB

Documentation

Index

• type Size
  • func Lookup(str string) (Size, bool)
  • func LookupTo(str string, to Unit) (Size, bool)
  • func New(size float64, unit Unit) Size
  • func NewInt(size int, unit Unit) Size
  • func (s Size) Round(n int32) float64
  • func (s Size) String() string
  • func (s Size) StringRound(n int32) string
  • func (s Size) To(to Unit) Size
• type Unit
  • func (u Unit) String() string

Types

type Size

type Size struct {
	Data float64
	Unit Unit
}

Size represents a bytes size in Unit

func Lookup

func Lookup(str string) (Size, bool)

Lookup returns a new size from the given string, return false if parse failed, use B unit if str has no unit string.

func LookupTo

func LookupTo(str string, to Unit) (Size, bool)

LookupTo returns a new size from the given string that convert to given unit, return false if failed

func New

func New(size float64, unit Unit) Size

New returns a new size

func NewInt

func NewInt(size int, unit Unit) Size

func (Size) Round

func (s Size) Round(n int32) float64

func (Size) String

func (s Size) String() string

String By default, only three decimal places are retained

func (Size) StringRound

func (s Size) StringRound(n int32) string

StringRound returns the string representation of the size if n < 0, use the original data as the float representation.

func (Size) To

func (s Size) To(to Unit) Size

type Unit

type Unit int

const (
	B Unit = 1 << (iota * 10)
	KB
	MB
	GB
	TB
	PB
	EB
)

func (Unit) String

func (u Unit) String() string