Unit.Bandwidth (Hyper v0.1.0)

A throughput, stored canonically in bytes per second. Build with bps/1 or the binary-prefix constructors (kibps/1, mibps/1, gibps/1, tibps/1); read back with as_bytes_per_sec/1. Arithmetic (+, -) and comparison (<, >, <=, >=) come from Unit.Operators.

Summary

t()

bps(v)

gibps(v)

kibps(v)

mibps(v)

parse(s)

Parse a string like "1GiBps". Suffixes: Bps/KiBps/MiBps/GiBps/TiBps.

parse!(s)

Like parse/1 but raises ArgumentError on bad input.

tibps(v)

zero()

The zero throughput (additive identity).

@opaque t()

@spec as_bytes_per_sec(t()) :: integer()

@spec bps(integer()) :: t()

@spec gibps(integer()) :: t()

@spec kibps(integer()) :: t()

@spec mibps(integer()) :: t()

@spec parse(String.t()) :: {:ok, t()} | {:error, {:bad_unit, String.t()}}

Parse a string like "1GiBps". Suffixes: Bps/KiBps/MiBps/GiBps/TiBps.

@spec parse!(String.t()) :: t()

Like parse/1 but raises ArgumentError on bad input.

@spec tibps(integer()) :: t()

@spec zero() :: t()

The zero throughput (additive identity).