Kapacity Core/io.github.developrofthings.kapacity

Package-level declarations

Types

ExperimentalKapacityApi

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class ExperimentalKapacityApi

InternalKapacityApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION])

annotation class InternalKapacityApi

Kapacity

@JvmInline

value class Kapacity : Comparable<Kapacity>

KapacityUnit

enum KapacityUnit : Enum<KapacityUnit>

Represents standard data capacity units, providing multiplier values for both the metric (base-10 / SI) and binary (base-2 / IEC) measurement systems.

Properties

byte

val Double.byte: Kapacity

Converts this Double value into a Kapacity representing Bytes.

val Float.byte: Kapacity

Converts this Float value into a Kapacity representing Bytes.

val Int.byte: Kapacity

Converts this Int value into a Kapacity representing Bytes.

val Long.byte: Kapacity

Converts this Long value into a Kapacity representing Bytes.

val ULong.byte: Kapacity

Converts this ULong value into a Kapacity representing Bytes.

exabyte

val Double.exabyte: Kapacity

Converts this Double value into a Kapacity representing metric Exabytes (EB).

val Float.exabyte: Kapacity

Converts this Float value into a Kapacity representing metric Exabytes (EB).

val Int.exabyte: Kapacity

Converts this Int value into a Kapacity representing metric Exabytes (EB).

val Long.exabyte: Kapacity

Converts this Long value into a Kapacity representing metric Exabytes (EB).

val ULong.exabyte: Kapacity

Converts this ULong value into a Kapacity representing metric Exabytes (EB).

exbibyte

val Double.exbibyte: Kapacity

Converts this Double value into a Kapacity representing binary Exbibytes (EiB).

val Float.exbibyte: Kapacity

Converts this Float value into a Kapacity representing binary Exbibytes (EiB).

val Int.exbibyte: Kapacity

Converts this Int value into a Kapacity representing binary Exbibytes (EiB).

val Long.exbibyte: Kapacity

Converts this Long value into a Kapacity representing binary Exbibytes (EiB).

val ULong.exbibyte: Kapacity

Converts this ULong value into a Kapacity representing binary Exbibytes (EiB).

gibibyte

val Double.gibibyte: Kapacity

Converts this Double value into a Kapacity representing binary Gibibytes (GiB).

val Float.gibibyte: Kapacity

Converts this Float value into a Kapacity representing binary Gibibytes (GiB).

val Int.gibibyte: Kapacity

Converts this Int value into a Kapacity representing binary Gibibytes (GiB).

val Long.gibibyte: Kapacity

Converts this Long value into a Kapacity representing binary Gibibytes (GiB).

val ULong.gibibyte: Kapacity

Converts this ULong value into a Kapacity representing binary Gibibytes (GiB).

gigabyte

val Double.gigabyte: Kapacity

Converts this Double value into a Kapacity representing metric Gigabytes (GB).

val Float.gigabyte: Kapacity

Converts this Float value into a Kapacity representing metric Gigabytes (GB).

val Int.gigabyte: Kapacity

Converts this Int value into a Kapacity representing metric Gigabytes (GB).

val Long.gigabyte: Kapacity

Converts this Long value into a Kapacity representing metric Gigabytes (GB).

val ULong.gigabyte: Kapacity

Converts this ULong value into a Kapacity representing metric Gigabytes (GB).

kapacity

val Array<Byte>.kapacity: Kapacity

val Array<UByte>.kapacity: Kapacity

Returns the Kapacity of this boxed Array, calculated directly from its size.

val ByteArray.kapacity: Kapacity

Returns the Kapacity of this primitive ByteArray, calculated directly from its size.

val UByteArray.kapacity: Kapacity

Returns the Kapacity of this unsigned UByteArray, calculated directly from its size.

val Collection<Byte>.kapacity: Kapacity

Returns the Kapacity of this Collection of bytes, calculated directly from its size.

kibibyte

val Double.kibibyte: Kapacity

Converts this Double value into a Kapacity representing binary Kibibytes (KiB).

val Float.kibibyte: Kapacity

Converts this Float value into a Kapacity representing binary Kibibytes (KiB).

val Int.kibibyte: Kapacity

Converts this Int value into a Kapacity representing binary Kibibytes (KiB).

val Long.kibibyte: Kapacity

Converts this Long value into a Kapacity representing binary Kibibytes (KiB).

val ULong.kibibyte: Kapacity

Converts this ULong value into a Kapacity representing binary Kibibytes (KiB).

kilobyte

val Double.kilobyte: Kapacity

Converts this Double value into a Kapacity representing metric Kilobytes (KB).

val Float.kilobyte: Kapacity

Converts this Float value into a Kapacity representing metric Kilobytes (KB).

val Int.kilobyte: Kapacity

Converts this Int value into a Kapacity representing metric Kilobytes (KB).

val Long.kilobyte: Kapacity

Converts this Long value into a Kapacity representing metric Kilobytes (KB).

val ULong.kilobyte: Kapacity

Converts this ULong value into a Kapacity representing metric Kilobytes (KB).

mebibyte

val Double.mebibyte: Kapacity

Converts this Double value into a Kapacity representing binary Mebibytes (MiB).

val Float.mebibyte: Kapacity

Converts this Float value into a Kapacity representing binary Mebibytes (MiB).

val Int.mebibyte: Kapacity

Converts this Int value into a Kapacity representing binary Mebibytes (MiB).

val Long.mebibyte: Kapacity

Converts this Long value into a Kapacity representing binary Mebibytes (MiB).

val ULong.mebibyte: Kapacity

Converts this ULong value into a Kapacity representing binary Mebibytes (MiB).

megabyte

val Double.megabyte: Kapacity

Converts this Double value into a Kapacity representing metric Megabytes (MB).

val Float.megabyte: Kapacity

Converts this Float value into a Kapacity representing metric Megabytes (MB).

val Int.megabyte: Kapacity

Converts this Int value into a Kapacity representing metric Megabytes (MB).

val Long.megabyte: Kapacity

Converts this Long value into a Kapacity representing metric Megabytes (MB).

val ULong.megabyte: Kapacity

Converts this ULong value into a Kapacity representing metric Megabytes (MB).

pebibyte

val Double.pebibyte: Kapacity

Converts this Double value into a Kapacity representing binary Pebibytes (PiB).

val Float.pebibyte: Kapacity

Converts this Float value into a Kapacity representing binary Pebibytes (PiB).

val Int.pebibyte: Kapacity

Converts this Int value into a Kapacity representing binary Pebibytes (PiB).

val Long.pebibyte: Kapacity

Converts this Long value into a Kapacity representing binary Pebibytes (PiB).

val ULong.pebibyte: Kapacity

Converts this ULong value into a Kapacity representing binary Pebibytes (PiB).

petabyte

val Double.petabyte: Kapacity

Converts this Double value into a Kapacity representing metric Petabytes (PB).

val Float.petabyte: Kapacity

Converts this Float value into a Kapacity representing metric Petabytes (PB).

val Int.petabyte: Kapacity

Converts this Int value into a Kapacity representing metric Petabytes (PB).

val Long.petabyte: Kapacity

Converts this Long value into a Kapacity representing metric Petabytes (PB).

val ULong.petabyte: Kapacity

Converts this ULong value into a Kapacity representing metric Petabytes (PB).

tebibyte

val Double.tebibyte: Kapacity

Converts this Double value into a Kapacity representing binary Tebibytes (TiB).

val Float.tebibyte: Kapacity

Converts this Float value into a Kapacity representing binary Tebibytes (TiB).

val Int.tebibyte: Kapacity

Converts this Int value into a Kapacity representing binary Tebibytes (TiB).

val Long.tebibyte: Kapacity

Converts this Long value into a Kapacity representing binary Tebibytes (TiB).

val ULong.tebibyte: Kapacity

Converts this ULong value into a Kapacity representing binary Tebibytes (TiB).

terabyte

val Double.terabyte: Kapacity

Converts this Double value into a Kapacity representing metric Terabytes (TB).

val Float.terabyte: Kapacity

Converts this Float value into a Kapacity representing metric Terabytes (TB).

val Int.terabyte: Kapacity

Converts this Int value into a Kapacity representing metric Terabytes (TB).

val Long.terabyte: Kapacity

Converts this Long value into a Kapacity representing metric Terabytes (TB).

val ULong.terabyte: Kapacity

Converts this ULong value into a Kapacity representing metric Terabytes (TB).

Functions

copyInto

fun Array<Byte>.copyInto(destination: Array<Byte>, destinationOffset: Int = 0, startIndex: Int = 0, kapacity: Kapacity): Array<Byte>

fun Array<UByte>.copyInto(destination: Array<UByte>, destinationOffset: Int = 0, startIndex: Int = 0, kapacity: Kapacity): Array<UByte>

fun ByteArray.copyInto(destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, kapacity: Kapacity): ByteArray

fun UByteArray.copyInto(destination: UByteArray, destinationOffset: Int = 0, startIndex: Int = 0, kapacity: Kapacity): UByteArray

Copies up to the specified kapacity of bytes from this array into the destination array.

toArray

fun Kapacity.toArray(init: (Int) -> Byte = { 0 }): Array<Byte>

Allocates a new boxed Array of Byte with a size equal to this capacity.

toArrayUnsigned

fun Kapacity.toArrayUnsigned(init: (Int) -> UByte = { 0U }): Array<UByte>

Allocates a new boxed Array of UByte with a size equal to this capacity.

toByteArray

fun Kapacity.toByteArray(): ByteArray

Allocates a new primitive ByteArray with a size equal to this capacity.

toKapacity

fun Double.toKapacity(unit: KapacityUnit, useMetric: Boolean = true): Kapacity

Converts this double-precision fractional value into a Kapacity instance based on the specified unit and standard.

fun Float.toKapacity(unit: KapacityUnit, useMetric: Boolean = true): Kapacity

Converts this single-precision fractional value into a Kapacity instance based on the specified unit and standard.

fun Long.toKapacity(unit: KapacityUnit, useMetric: Boolean = true): Kapacity

Converts this numerical value into a Kapacity instance based on the specified unit and standard.

fun ULong.toKapacity(unit: KapacityUnit, useMetric: Boolean = true): Kapacity

Converts this unsigned numerical value into a Kapacity instance based on the specified unit and standard.

toUByteArray

fun Kapacity.toUByteArray(): UByteArray

Allocates a new primitive UByteArray with a size equal to this capacity.