Packages > pkl > pkl.base

DataSize0.27.0

Properties
Methods

external class DataSize extends Any

A quantity of binary data, represented as a value (e.g. 30.5) and unit (e.g. mb).

Known subtypes:
Known usages:
All versions:

Properties

link
value: Number

The value of this data size.
Returns Int if possible and Float otherwise.

Facts:
```
1.mb.value == 1
2.2.mib.value == 2.2
```
link
unit: DataSizeUnit

The unit of this data size.
Facts:
```
1.mb.unit == "mb"
2.2.mib.unit == "mib"
```
link
isPositive: Boolean

Tells if this data size has a value of zero or greater.
Facts:
```
2.mb.isPositive
!(-2.mb.isPositive)
```
link

isBinaryUnit: Boolean

Tells if this data size has a binary unit, for example mib.

Returns true for unit b (bytes).
link

isDecimalUnit: Boolean

Tells if this data size has a decimal unit, for example mb.

Returns true for unit b (bytes).

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function
isBetween(start: DataSize, inclusiveEnd: DataSize): unknown

Tells if this data size is greater than or equal to start and less than or equal to inclusiveEnd.
Facts:
```
3.kb.isBetween(2000.b, 4.kb)
3.kb.isBetween(3000.b, 4.kb)
3.kb.isBetween(2000.b, 3.kb)
!3.kb.isBetween(1.kb, 2.kb)
```
link

function
toUnit(unit: DataSizeUnit): DataSize

Returns the equivalent data size with the given unit.
Facts:
```
1000.kb.toUnit("mb") == 1.mb
1.mb.toUnit("kb") == 1000.kb
```
link

function
toBinaryUnit(): DataSize

Returns the equivalent data size with a binary unit.
Returns this data size unchanged if it already has a binary unit.

Facts:
```
1024.kb.toBinaryUnit() == 1000.kib
1024.mb.toBinaryUnit() == 1000.mib

1000.kib.toBinaryUnit() == 1000.kib
1000.b.toBinaryUnit() == 1000.b
```
link

function
toDecimalUnit(): DataSize

Returns the equivalent data size with a decimal unit.
Returns this data size unchanged if it already has a decimal unit.

Facts:
```
1000.kib.toDecimalUnit() == 1024.kb
1000.mib.toDecimalUnit() == 1024.mb

1000.kb.toDecimalUnit() == 1000.kb
1000.b.toDecimalUnit() == 1000.b
```