humanise/bytes

This module contains functions for formatting amounts of data to Strings (e.g. "100.0B", "1.5GB").

Usage generally looks like this:

bytes.Kilobytes(2000.0) |> bytes.humanise |> bytes.to_string // "2.0MB"

// or, if you don't want to change the unit
bytes.Kilobytes(2000.0) |> bytes.to_string // "2000.0KB"

Note: This module is for 1000-multiple units! (kilobyte, megabyte, etc.) If you’re looking for 1024-multiple units (kibibyte, mebibyte, etc.), look at the bytes1024 module instead.

Types

Bytes

</>

The main type for holding data amount information.

Use its constructors directly to specify a unit for the value you want to format.

pub type Bytes {
  Bytes(Float)
  Kilobytes(Float)
  Megabytes(Float)
  Gigabytes(Float)
  Terabytes(Float)
}

Constructors

```
Bytes(Float)
```
```
Kilobytes(Float)
```
```
Megabytes(Float)
```
```
Gigabytes(Float)
```
```
Terabytes(Float)
```

Functions

as_bytes

</>

pub fn as_bytes(this bytes: Bytes) -> Float

Convert a value to bytes.

Example:

bytes.Kilobytes(1.0) |> bytes.as_bytes // 1000.0

as_gigabytes

</>

pub fn as_gigabytes(this bytes: Bytes) -> Float

Convert a value to gigabytes.

Example:

bytes.Megabytes(1000.0) |> bytes.as_gigabytes // 1.0

as_kilobytes

</>

pub fn as_kilobytes(this bytes: Bytes) -> Float

Convert a value to kilobytes.

Example:

bytes.Bytes(1000.0) |> bytes.as_kilobytes // 1.0

as_megabytes

</>

pub fn as_megabytes(this bytes: Bytes) -> Float

Convert a value to megabytes.

Example:

bytes.Kilobytes(1000.0) |> bytes.as_megabytes // 1.0

as_terabytes

</>

pub fn as_terabytes(this bytes: Bytes) -> Float

Convert a value to terabytes.

Example:

bytes.Gigabytes(1000.0) |> bytes.as_terabytes // 1.0

humanise

</>

pub fn humanise(this bytes: Bytes) -> Bytes

Convert a value to a more optimal unit, if possible.

Example:

bytes.Megabytes(0.5) |> bytes.humanise // bytes.Kilobytes(500.0)

to_string

</>

pub fn to_string(this bytes: Bytes) -> String

Format a value as a String, rounded to at most 2 decimal places, followed by a unit suffix.

Example:

bytes.Gigabytes(30.125) |> bytes.to_string // "30.13GB"