Kapacity Core/io.github.developrofthings.kapacity/Kapacity

Kapacity

@JvmInline

value class Kapacity : Comparable<Kapacity>

Types

Companion

object Companion

Properties

rawBytes

val rawBytes: Long

rawBytesCoercedToIntRange

val rawBytesCoercedToIntRange: Int

Coerces this capacity's exact byte count into a standard 32-bit Int suitable for memory allocation.

Functions

compareTo

open operator override fun compareTo(other: Kapacity): Int

div

operator fun div(other: Kapacity): Long

Divides this Kapacity by another Kapacity.

operator fun div(divisor: Double): Kapacity

operator fun div(divisor: Float): Kapacity

operator fun div(divisor: Int): Kapacity

operator fun div(divisor: Long): Kapacity

Divides this capacity by a given scalar divisor. Ensures the resulting capacity is never negative.

minus

operator fun minus(other: Kapacity): Kapacity

Subtracts another Kapacity from this one. Ensures the resulting capacity is never negative.

operator fun minus(bytes: Double): Kapacity

operator fun minus(bytes: Float): Kapacity

operator fun minus(bytes: Int): Kapacity

operator fun minus(bytes: Long): Kapacity

Subtracts the specified number of bytes from this capacity. Ensures the resulting capacity is never negative.

plus

operator fun plus(other: Kapacity): Kapacity

Adds another Kapacity to this one. Ensures the resulting capacity is never negative.

operator fun plus(bytes: Double): Kapacity

operator fun plus(bytes: Float): Kapacity

operator fun plus(bytes: Int): Kapacity

operator fun plus(bytes: Long): Kapacity

Adds the specified number of bytes to this capacity. Ensures the resulting capacity is never negative.

times

operator fun times(factor: Double): Kapacity

operator fun times(factor: Float): Kapacity

operator fun times(bytes: Int): Kapacity

operator fun times(factor: Long): Kapacity

Multiplies this capacity by a given scalar factor. Ensures the resulting capacity is never negative.

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.

toString

open override fun toString(): String

fun toString(unit: KapacityUnit? = null, useMetric: Boolean = true, useUnitSuffix: Boolean = true, useAbbreviation: Boolean = true): String

toUByteArray

fun Kapacity.toUByteArray(): UByteArray

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