DataSize, a standard type

An amount of data: 5MB or 4KiB.

Use it for file sizes and storage limits. MB is a million bytes and MiB is 2 to the 20. For data per second, use Bitrate.

Shape

One value, with no fields to fill in. As text it reads 5000000 B.

Example

example

DataSize(5MB)

text.parse(raw, as: DataSize) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as 5, 1.2.3 or five.

These operations give one: units.of and units.sum.

Good to know

It is held in whole bytes, and text.format takes unit:.
== tells you whether two are the same, and < and list.sort_by compare and sort them.

In JSON

An object of its parts, in a request, a response or json.write:

json

{"value":"0","unit":"B"}{"value":"1024","unit":"B"}{"value":"5000000","unit":"B"}

Details

Text form, storage, how it is shown, and operations

DataSize is in the group Maths and data, and has been in Jadpo since 0.1.0.

Text form

text.from writes one standard text form, the same form text.parse reads back: 0 B, 1024 B and 5000000 B.

How it is stored

It is stored in one column named for the field, of type numeric(38, 0), holding the dataSize in bytes (B). 1024 B is stored as 1024.

How it is shown to people

text.format(value, locale:) shows it to people in their locale. A call may also give unit:.

With locale: Locale.en_gb:

Value	Shown
`0 B`	`0 B`
`1024 B`	`1,024 B`
`5000000 B`	`5,000,000 B`

Operations

units.in(value: Quantity, unit: QuantityUnit, scale: Int, rounding: Rounding) -> Decimal: value in unit, a unit of its kind, as a Decimal of scale places rounded by rounding: units.in(5km, LengthUnit.mile, scale: 2, rounding: Rounding.half_even) is 3.11.
units.of(value: Number, unit: QuantityUnit) -> Quantity: value of unit, an Int or a Decimal, as the quantity of unit's kind, converted exactly to the base unit and rounded half to even to the kind's scale: units.of(5, LengthUnit.mile).
units.sum(items: List<Quantity>) -> Quantity: The items added up, all of one kind; nothing for no items. A Temperature or a SoundLevel doesn't add to itself, so neither is summed.

It also takes text.parse, text.from, text.format, json.read, json.write and ==. How every standard type behaves says how they work.