README ¶
Introduction
go-units is a library to transform human friendly measurements into machine friendly values.
Usage
See the docs in godoc for examples and documentation.
Copyright and license
Copyright © 2015 Docker, Inc. All rights reserved, except as follows. Code is released under the Apache 2.0 license. The README.md file, and files in the "docs" folder are licensed under the Creative Commons Attribution 4.0 International License under the terms and conditions set forth in the file "LICENSE.docs". You may obtain a duplicate copy of the same license, titled CC-BY-SA-4.0, at http://creativecommons.org/licenses/by/4.0/.
Documentation ¶
Overview ¶
Package units provides helper function to parse and print size and time units in human-readable format.
Index ¶
- Constants
- func BytesSize(size float64) string
- func CustomSize(format string, size float64, base float64, _map []string) string
- func FromHumanSize(size string) (int64, error)
- func HumanDuration(d time.Duration) string
- func HumanSize(size float64) string
- func RAMInBytes(size string) (int64, error)
- type Rlimit
- type Ulimit
Constants ¶
Variables ¶
This section is empty.
Functions ¶
func BytesSize ¶
BytesSize returns a human-readable size in bytes, kibibytes, mebibytes, gibibytes, or tebibytes (eg. "44kiB", "17MiB").
func CustomSize ¶
CustomSize returns a human-readable approximation of a size using custom format.
func FromHumanSize ¶
FromHumanSize returns an integer from a human-readable specification of a size using SI standard (eg. "44kB", "17MB").
func HumanDuration ¶
HumanDuration returns a human-readable approximation of a duration (eg. "About a minute", "4 hours ago", etc.).
func HumanSize ¶
HumanSize returns a human-readable approximation of a size capped at 4 valid numbers (eg. "2.746 MB", "796 KB").
func RAMInBytes ¶
RAMInBytes parses a human-readable string representing an amount of RAM in bytes, kibibytes, mebibytes, gibibytes, or tebibytes and returns the number of bytes, or -1 if the string is unparseable. Units are case-insensitive, and the 'b' suffix is optional.
Types ¶
type Rlimit ¶
type Rlimit struct { Type int `json:"type,omitempty"` Hard uint64 `json:"hard,omitempty"` Soft uint64 `json:"soft,omitempty"` }
Rlimit specifies the resource limits, such as max open files.