types/kotools.types.number/ZeroInt

ZeroInt

@Serializable(with = ZeroIntSerializer::class)

@Since(version = KotoolsTypesVersion.V4_0_0)

object ZeroInt : PositiveInt, NegativeInt

Represents an integer number of type Int that equals zero.

Serialization and deserialization

The serialization and deserialization processes of this type behave like for the Int type.

Here's an example of Kotlin code that encodes and decodes this type using the JavaScript Object Notation (JSON) format from kotlinx.serialization:

val encoded: String = Json.encodeToString(ZeroInt)
println(encoded) // 0
val decoded: ZeroInt = Json.decodeFromString(encoded)
println(decoded === ZeroInt) // true

Functions

compareTo

@Since(version = KotoolsTypesVersion.V4_1_0)

open infix operator override fun compareTo(other: AnyInt): Int

Compares this integer with the other one for order. Returns zero if this integer equals the other one, a negative number if it's less than the other one, or a positive number if it's greater than the other one.

div

@Since(version = KotoolsTypesVersion.V4_1_0)

operator fun AnyInt.div(other: NonZeroInt): Int

@Since(version = KotoolsTypesVersion.V4_1_0)

operator fun NegativeInt.div(other: StrictlyNegativeInt): PositiveInt

@Since(version = KotoolsTypesVersion.V4_1_0)

operator fun NegativeInt.div(other: StrictlyPositiveInt): NegativeInt

@Since(version = KotoolsTypesVersion.V4_1_0)

operator fun PositiveInt.div(other: StrictlyNegativeInt): NegativeInt

@Since(version = KotoolsTypesVersion.V4_1_0)

operator fun PositiveInt.div(other: StrictlyPositiveInt): PositiveInt

Divides this integer by the other one, truncating the result to an integer that is closer to zero.