humanise/bytes1024

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

Usage generally looks like this:

bytes1024.Kibibytes(2048.0) |> bytes1024.humanise |> bytes1024.to_string // "2.0MiB"

// or, if you don't want to change the unit
bytes1024.Kilobytes(2048.0) |> bytes1024.to_string // "2048.0KiB"

Note: This module is for 1024-multiple units! (kibibyte, megbibyte, etc.) If you’re looking for 1000-multiple units (kilobyte, megabyte, etc.), look at the bytes 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)
  Kibibytes(Float)
  Mebibytes(Float)
  Gibibytes(Float)
  Tebibytes(Float)
}

Constructors

```
Bytes(Float)
```
```
Kibibytes(Float)
```
```
Mebibytes(Float)
```
```
Gibibytes(Float)
```
```
Tebibytes(Float)
```

Functions

as_bytes

</>

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

Convert a value to bytes.

Example:

bytes1024.Kibibytes(1.0) |> bytes1024.as_bytes // 1024.0

as_gibibytes

</>

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

Convert a value to gibibytes.

Example:

bytes1024.Mebibytes(1024.0) |> bytes1024.as_gibibytes // 1.0

as_kibibytes

</>

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

Convert a value to kibibytes.

Example:

bytes1024.Bytes(1024.0) |> bytes1024.as_kibibytes // 1.0

as_mebibytes

</>

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

Convert a value to mebibytes.

Example:

bytes1024.Kibibytes(1024.0) |> bytes1024.as_mebibytes // 1.0

as_tebibytes

</>

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

Convert a value to tebibytes.

Example:

bytes1024.Gibibytes(1024.0) |> bytes1024.as_tebibytes // 1.0

humanise

</>

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

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

Example:

bytes1024.Mebibytes(0.5) |> bytes1024.humanise // bytes1024.Kibibytes(512.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:

bytes1024.Gibibytes(30.125) |> bytes1024.to_string // "30.13GiB"