types/kotools.types.number/AnyInt

AnyInt

@Serializable(with = AnyIntSerializer::class)

@Since(version = KotoolsTypesVersion.V4_0_0)

Represents an integer number of type Int.

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 number: AnyInt = 123.toNonZeroInt()
    .getOrThrow()
val encoded: String = Json.encodeToString(number)
assertEquals(expected = "123", actual = encoded)
val decoded: AnyInt = Json.decodeFromString(encoded)
assertEquals(expected = number, actual = decoded)

Inheritors

NegativeInt

NonZeroInt

PositiveInt

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

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

minus

@Since(version = KotoolsTypesVersion.V4_1_0)

operator fun AnyInt.minus(other: Int): Int

@Since(version = KotoolsTypesVersion.V4_1_0)

operator fun AnyInt.minus(other: AnyInt): Int

Subtracts the other integer from this one.

plus

@Since(version = KotoolsTypesVersion.V4_1_0)