File Size v2.1.1 FileSize.Units.Info View Source

A struct that contains information for a particular unit.

Link to this section Summary

Functions

Gets the max value of the given unit.

Gets the min value of the given unit.

Gets a range of min and max values for the given unit.

Link to this section Types

Link to this type

t() View Source
t() :: %FileSize.Units.Info{
  exp: non_neg_integer(),
  mod: module(),
  name: FileSize.unit(),
  symbol: FileSize.unit_symbol(),
  system: nil | FileSize.unit_system()
}

Link to this section Functions

Link to this function

max_value(unit_info) View Source
max_value(t()) :: non_neg_integer()

Gets the max value of the given unit.

Link to this function

min_value(unit_info) View Source
min_value(t()) :: non_neg_integer()

Gets the min value of the given unit.

Link to this function

value_range(unit_info) View Source
value_range(t()) :: Range.t()

Gets a range of min and max values for the given unit.