kotlin (original) (raw)
Package-level declarations
Core functions and types, available on all supported platforms.
Core functions and types, available on all supported platforms.
Core functions and types, available on all supported platforms.
Core functions and types, available on all supported platforms.
Core functions and types, available on all supported platforms.
Core functions and types, available on all supported platforms.
Types
expect open class Any
The root of the Kotlin class hierarchy. Every Kotlin class has Any as a superclass.
actual open class Any
The root of the Kotlin class hierarchy. Every Kotlin class has Any as a superclass.
actual open class Any
The root of the Kotlin class hierarchy. Every Kotlin class has Any as a superclass.
actual open class Any
The root of the Kotlin class hierarchy. Every Kotlin class has Any as a superclass.
actual open class Any
The root of the Kotlin class hierarchy. Every Kotlin class has Any as a superclass.
actual open class Any
The root of the Kotlin class hierarchy. Every Kotlin class has Any as a superclass.
A generic array of objects. When targeting the JVM, instances of this class are represented as T[]
. Array instances can be created using the arrayOf, arrayOfNulls and emptyArray standard library functions.
A generic array of objects. When targeting the JVM, instances of this class are represented as T[]
. Array instances can be created using the arrayOf, arrayOfNulls and emptyArray standard library functions.
A generic array of objects. When targeting the JVM, instances of this class are represented as T[]
. Array instances can be created using the arrayOf, arrayOfNulls and emptyArray standard library functions.
A generic array of objects. When targeting the JVM, instances of this class are represented as T[]
. Array instances can be created using the arrayOf, arrayOfNulls and emptyArray standard library functions.
A generic array of objects. When targeting the JVM, instances of this class are represented as T[]
. Array instances can be created using the arrayOf, arrayOfNulls and emptyArray standard library functions.
A generic array of objects. When targeting the JVM, instances of this class are represented as T[]
. Array instances can be created using the arrayOf, arrayOfNulls and emptyArray standard library functions.
A resource that can be closed or released.
Represents a value which is either true
or false
.
Represents a value which is either true
or false
.
Represents a value which is either true
or false
. On the JVM, non-nullable values of this type are represented as values of the primitive type boolean
.
Represents a value which is either true
or false
.
Represents a value which is either true
or false
.
Represents a value which is either true
or false
.
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
An array of booleans. When targeting the JVM, instances of this class are represented as boolean[]
.
Allows to infer generic type arguments of a function from the calls in the annotated function parameter of that function.
Represents a 8-bit signed integer.
Represents a 8-bit signed integer.
Represents a 8-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type byte
.
Represents a 8-bit signed integer.
Represents a 8-bit signed integer.
Represents a 8-bit signed integer.
An array of bytes. When targeting the JVM, instances of this class are represented as byte[]
.
An array of bytes. When targeting the JVM, instances of this class are represented as byte[]
.
An array of bytes. When targeting the JVM, instances of this class are represented as byte[]
.
An array of bytes. When targeting the JVM, instances of this class are represented as byte[]
.
An array of bytes. When targeting the JVM, instances of this class are represented as byte[]
.
An array of bytes. When targeting the JVM, instances of this class are represented as byte[]
.
Represents a 16-bit Unicode character.
Represents a 16-bit Unicode character.
Represents a 16-bit Unicode character. On the JVM, non-nullable values of this type are represented as values of the primitive type char
.
Represents a 16-bit Unicode character.
Represents a 16-bit Unicode character.
Represents a 16-bit Unicode character.
An array of chars. When targeting the JVM, instances of this class are represented as char[]
.
An array of chars. When targeting the JVM, instances of this class are represented as char[]
.
An array of chars. When targeting the JVM, instances of this class are represented as char[]
.
An array of chars. When targeting the JVM, instances of this class are represented as char[]
.
An array of chars. When targeting the JVM, instances of this class are represented as char[]
.
An array of chars. When targeting the JVM, instances of this class are represented as char[]
.
Represents a readable sequence of Char values.
Represents a readable sequence of Char values.
Represents a readable sequence of Char values.
Represents a readable sequence of Char values.
Classes which inherit from this interface have a defined total ordering between their instances.
Classes which inherit from this interface have a defined total ordering between their instances.
Classes which inherit from this interface have a defined total ordering between their instances.
Classes which inherit from this interface have a defined total ordering between their instances.
Provides a comparison function for imposing a total ordering between instances of the type T.
Provides a comparison function for imposing a total ordering between instances of the type T.
Provides a comparison function for imposing a total ordering between instances of the type T.
In previous versions of Kotlin, the generated 'copy' method of a data class always had public visibility, even if the primary constructor was non-public. That exposed the non-public constructor of the data class.
Signifies that the annotated functional type has the prefix of size count
for context receivers. Thus, @ContextFunctionTypeParams(2) @ExtensionFunctionType Function4<String, Int, Double, Byte, Unit>
is a normalized representation of context(String, Int) Double.(Byte) -> Unit
.
Defines deep recursive function that keeps its stack on the heap, which allows very deep recursive computations that do not use the actual call stack. To initiate a call to this deep recursive function use its invoke function. As a rule of thumb, it should be used if recursion goes deeper than a thousand calls.
Marks the annotated declaration as deprecated.
Marks the annotated declaration as deprecated. In contrast to Deprecated, severity of the reported diagnostic is not a constant value, but differs depending on the API version of the usage (the value of the -api-version
argument when compiling the module where the usage is located). If the API version is greater or equal than hiddenSince, the declaration will not be accessible from the code (as if it was deprecated with level DeprecationLevel.HIDDEN), otherwise if the API version is greater or equal than errorSince, the usage will be marked as an error (as with DeprecationLevel.ERROR), otherwise if the API version is greater or equal than warningSince, the usage will be marked as a warning (as with DeprecationLevel.WARNING), otherwise the annotation is ignored.
Possible levels of a deprecation. The level specifies how the deprecated element usages are reported in code.
Represents a double-precision 64-bit IEEE 754 floating point number.
Represents a double-precision 64-bit IEEE 754 floating point number.
Represents a double-precision 64-bit IEEE 754 floating point number. On the JVM, non-nullable values of this type are represented as values of the primitive type double
.
Represents a double-precision 64-bit IEEE 754 floating point number.
Represents a double-precision 64-bit IEEE 754 floating point number.
Represents a double-precision 64-bit IEEE 754 floating point number.
An array of doubles. When targeting the JVM, instances of this class are represented as double[]
.
An array of doubles. When targeting the JVM, instances of this class are represented as double[]
.
An array of doubles. When targeting the JVM, instances of this class are represented as double[]
.
An array of doubles. When targeting the JVM, instances of this class are represented as double[]
.
An array of doubles. When targeting the JVM, instances of this class are represented as double[]
.
An array of doubles. When targeting the JVM, instances of this class are represented as double[]
.
When applied to annotation class X specifies that X defines a DSL language
Forces a top-level property to be initialized eagerly, opposed to lazily on the first access to file and/or property.
Forces a top-level property to be initialized eagerly, opposed to lazily on the first access to file and/or property.
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
annotation class ExperimentalMultiplatform
The experimental multiplatform support API marker.
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
annotation class ExperimentalStdlibApi
This annotation marks the standard library API that is considered experimental and is not subject to the general compatibility guarantees given for the standard library: the behavior of such API may be changed or the API may be removed completely in any further release.
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
annotation class ExperimentalUnsignedTypes
Marks the API that is dependent on the experimental unsigned types, including those types themselves.
In previous versions of Kotlin, the generated 'copy' method of a data class always had public visibility, even if the primary constructor was non-public. That exposed the non-public constructor of the data class.
Signifies that the annotated functional type represents an extension function.
Represents a single-precision 32-bit IEEE 754 floating point number.
Represents a single-precision 32-bit IEEE 754 floating point number.
Represents a single-precision 32-bit IEEE 754 floating point number. On the JVM, non-nullable values of this type are represented as values of the primitive type float
.
Represents a single-precision 32-bit IEEE 754 floating point number.
Represents a single-precision 32-bit IEEE 754 floating point number.
Represents a single-precision 32-bit IEEE 754 floating point number.
An array of floats. When targeting the JVM, instances of this class are represented as float[]
.
An array of floats. When targeting the JVM, instances of this class are represented as float[]
.
An array of floats. When targeting the JVM, instances of this class are represented as float[]
.
An array of floats. When targeting the JVM, instances of this class are represented as float[]
.
An array of floats. When targeting the JVM, instances of this class are represented as float[]
.
An array of floats. When targeting the JVM, instances of this class are represented as float[]
.
Represents a value of a functional type, such as a lambda, an anonymous function or a function reference.
Represents a 32-bit signed integer.
Represents a 32-bit signed integer.
Represents a 32-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type int
.
Represents a 32-bit signed integer.
Represents a 32-bit signed integer.
Represents a 32-bit signed integer.
An array of ints. When targeting the JVM, instances of this class are represented as int[]
.
An array of ints. When targeting the JVM, instances of this class are represented as int[]
.
An array of ints. When targeting the JVM, instances of this class are represented as int[]
.
An array of ints. When targeting the JVM, instances of this class are represented as int[]
.
An array of ints. When targeting the JVM, instances of this class are represented as int[]
.
An array of ints. When targeting the JVM, instances of this class are represented as int[]
.
Implements annotated function in JavaScript and automatically imports is to Wasm. code string must contain JS expression that evaluates to JS function with signature that matches annotated kotlin function
Represents a version of the Kotlin standard library.
Represents a value with lazy initialization.
Specifies how a Lazy instance synchronizes initialization and publication among multiple threads. On platforms with no notion of synchronization and threads (JS and WASM), all modes are considered equal to the default implementation.
Represents a 64-bit signed integer.
Represents a 64-bit signed integer.
Represents a 64-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type long
.
Represents a 64-bit signed integer.
Represents a 64-bit signed integer.
Represents a 64-bit signed integer.
An array of longs. When targeting the JVM, instances of this class are represented as long[]
.
An array of longs. When targeting the JVM, instances of this class are represented as long[]
.
An array of longs. When targeting the JVM, instances of this class are represented as long[]
.
An array of longs. When targeting the JVM, instances of this class are represented as long[]
.
An array of longs. When targeting the JVM, instances of this class are represented as long[]
.
An array of longs. When targeting the JVM, instances of this class are represented as long[]
.
This annotation is present on any class file produced by the Kotlin compiler and is read by the compiler and reflection. Parameters have very short JVM names on purpose: these names appear in all generated class files, and we'd like to reduce their size.
Nothing has no instances. You can use Nothing to represent "a value that never exists": for example, if a function has the return type of Nothing, it means that it never returns (always throws an exception).
Nothing has no instances. You can use Nothing to represent "a value that never exists": for example, if a function has the return type of Nothing, it means that it never returns (always throws an exception).
Nothing has no instances. You can use Nothing to represent "a value that never exists": for example, if a function has the return type of Nothing, it means that it never returns (always throws an exception).
Nothing has no instances. You can use Nothing to represent "a value that never exists": for example, if a function has the return type of Nothing, it means that it never returns (always throws an exception).
Nothing has no instances. You can use Nothing to represent "a value that never exists": for example, if a function has the return type of Nothing, it means that it never returns (always throws an exception).
Nothing has no instances. You can use Nothing to represent "a value that never exists": for example, if a function has the return type of Nothing, it means that it never returns (always throws an exception).
An exception is thrown to indicate that a method body remains to be implemented.
expect abstract class Number
Superclass for all platform classes representing numeric values.
actual abstract class Number
Superclass for all platform classes representing numeric values.
actual abstract class Number
Superclass for all platform classes representing numeric values.
actual abstract class Number
Superclass for all platform classes representing numeric values.
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.EXPRESSION, AnnotationTarget.FILE, AnnotationTarget.TYPEALIAS])
annotation class OptIn(val markerClass: KClass<out Annotation>)
Allows to use the API denoted by the given markers in the annotated file, declaration, or expression. If a declaration is annotated with OptIn, its usages are not required to opt in to that API.
Marks an expected annotation class that it isn't required to have actual counterparts in all platforms.
Enables overload selection based on the type of the value returned from lambda argument.
Represents a generic pair of two values.
Annotates type arguments of functional type and holds corresponding parameter name specified by the user in type declaration (if any).
When applied to a class or a member with internal visibility allows using it from public inline functions and makes it effectively public.
Specifies a code fragment that can be used to replace a deprecated function, property or class. Tools such as IDEs can automatically apply the replacements specified through this annotation.
Signals that the annotated annotation class is a marker of an API that requires an explicit opt-in.
A discriminated union that encapsulates a successful outcome with a value of type T or a failure with an arbitrary Throwable exception.
Represents a 16-bit signed integer.
Represents a 16-bit signed integer.
Represents a 16-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type short
.
Represents a 16-bit signed integer.
Represents a 16-bit signed integer.
Represents a 16-bit signed integer.
An array of shorts. When targeting the JVM, instances of this class are represented as short[]
.
An array of shorts. When targeting the JVM, instances of this class are represented as short[]
.
An array of shorts. When targeting the JVM, instances of this class are represented as short[]
.
An array of shorts. When targeting the JVM, instances of this class are represented as short[]
.
An array of shorts. When targeting the JVM, instances of this class are represented as short[]
.
An array of shorts. When targeting the JVM, instances of this class are represented as short[]
.
Specifies the first version of Kotlin where a declaration has appeared. Using the declaration and specifying an older API version (via the -api-version
command line option) will result in an error.
The String
class represents character strings. All string literals in Kotlin programs, such as "abc"
, are implemented as instances of this class.
The String
class represents character strings. All string literals in Kotlin programs, such as "abc"
, are implemented as instances of this class.
The String
class represents character strings. All string literals in Kotlin programs, such as "abc"
, are implemented as instances of this class.
The String
class represents character strings. All string literals in Kotlin programs, such as "abc"
, are implemented as instances of this class.
The String
class represents character strings. All string literals in Kotlin programs, such as "abc"
, are implemented as instances of this class.
Annotation that marks open for subclassing classes and interfaces, and makes implementation and extension of such declarations as requiring an explicit opt-in.
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.TYPE_PARAMETER, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPE, AnnotationTarget.EXPRESSION, AnnotationTarget.FILE, AnnotationTarget.TYPEALIAS])
annotation class Suppress(val names: String)
Suppresses the given compilation warnings in the annotated element.
The base class for all errors and exceptions. Only instances of this class can be thrown or caught.
The base class for all errors and exceptions. Only instances of this class can be thrown or caught.
The base class for all errors and exceptions. Only instances of this class can be thrown or caught.
The base class for all errors and exceptions. Only instances of this class can be thrown or caught.
The base class for all errors and exceptions. Only instances of this class can be thrown or caught.
The base class for all errors and exceptions. Only instances of this class can be thrown or caught.
This annotation indicates what exceptions should be declared by a function when compiled to a platform method in Kotlin/JVM and Kotlin/Native.
This annotation indicates what exceptions should be declared by a function when compiled to a JVM method.
This annotation indicates what exceptions should be declared by a function when compiled to a platform method.
Represents a triad of values
expect object Unit
The type with only one value: the Unit
object. This type corresponds to the void
type in Java.
actual object Unit
The type with only one value: the Unit
object. This type corresponds to the void
type in Java.
actual object Unit
The type with only one value: the Unit
object. This type corresponds to the void
type in Java.
actual object Unit
The type with only one value: the Unit
object.
actual object Unit
The type with only one value: the Unit
object. This type corresponds to the void
type in Java.
actual object Unit
The type with only one value: the Unit
object. This type corresponds to the void
type in Java.
Suppresses errors about variance conflict
Properties
Returns the code of this Char.
Returns true
if this lateinit property has been assigned a value, and false
otherwise.
Returns an array of stack trace elements representing the stack trace pertaining to this throwable.
Returns a list of all exceptions that were suppressed in order to deliver this exception.
Returns a list of all exceptions that were suppressed in order to deliver this exception.
Returns a list of all exceptions that were suppressed in order to deliver this exception.
Returns a list of all exceptions that were suppressed in order to deliver this exception.
Returns a list of all exceptions that were suppressed in order to deliver this exception.
Returns a list of all exceptions that were suppressed in order to deliver this exception.
Functions
When supported by the platform, adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.
Adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.
When supported by the platform, adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.
Adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.
Adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.
Adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.
Calls the specified function block with this
value as its argument and returns this
value.
Performs a bitwise AND operation between the two values.
Calls the specified function block with this
value as its receiver and returns this
value.
Returns an array containing the specified elements.
Returns an array containing the specified elements.
Returns an array containing the specified elements.
actual inline external fun <T> arrayOf(vararg elements: T): Array<T>
Returns an array containing the specified elements.
Returns an array containing the specified elements.
Returns an array containing the specified elements.
Returns an array of objects of the given type with the given size, initialized with null values.
Returns an array of objects of the given type with the given size, initialized with null values.
Returns an array of objects of the given type with the given size, initialized with null values.
Returns an array of objects of the given type with the given size, initialized with null values.
Returns an array of objects of the given type with the given size, initialized with null values.
Returns an array of objects of the given type with the given size, initialized with null values.
Throws an AssertionError if the value is false and runtime assertions have been enabled on the JVM using the -ea JVM option.
Throws an AssertionError calculated by lazyMessage if the value is false and runtime assertions have been enabled on the JVM using the -ea JVM option.
Throws an AssertionError if the value is false and runtime assertions have been enabled during compilation.
Throws an AssertionError calculated by lazyMessage if the value is false and runtime assertions have been enabled during compilation.
Returns an array containing the specified boolean values.
Returns an array containing the specified boolean values.
Returns an array containing the specified boolean values.
Returns an array containing the specified boolean values.
Returns an array containing the specified boolean values.
Returns an array containing the specified boolean values.
Returns an array containing the specified Byte numbers.
Returns an array containing the specified Byte numbers.
Returns an array containing the specified Byte numbers.
Returns an array containing the specified Byte numbers.
Returns an array containing the specified Byte numbers.
Returns an array containing the specified Byte numbers.
Creates a Char with the specified code, or throws an exception if the code is out of Char.MIN_VALUE.code..Char.MAX_VALUE.code
.
Creates a Char with the specified code.
Creates a Char with the specified code.
Creates a Char with the specified code.
Creates a Char with the specified code.
Creates a Char with the specified code.
Returns an array containing the specified characters.
Returns an array containing the specified characters.
Returns an array containing the specified characters.
Returns an array containing the specified characters.
Returns an array containing the specified characters.
Returns an array containing the specified characters.
Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Byte number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Short number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this UByte number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this UInt number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this ULong number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this UShort number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive most significant bits that are zero in the binary representation of this Long number.
Counts the number of set bits in the binary representation of this Byte number.
Counts the number of set bits in the binary representation of this Int number.
Counts the number of set bits in the binary representation of this Long number.
Counts the number of set bits in the binary representation of this Short number.
Counts the number of set bits in the binary representation of this UByte number.
Counts the number of set bits in the binary representation of this UInt number.
Counts the number of set bits in the binary representation of this ULong number.
Counts the number of set bits in the binary representation of this UShort number.
Counts the number of set bits in the binary representation of this Int number.
Counts the number of set bits in the binary representation of this Long number.
Counts the number of set bits in the binary representation of this Int number.
Counts the number of set bits in the binary representation of this Long number.
Counts the number of set bits in the binary representation of this Int number.
Counts the number of set bits in the binary representation of this Long number.
Counts the number of set bits in the binary representation of this Int number.
Counts the number of set bits in the binary representation of this Long number.
Counts the number of set bits in the binary representation of this Int number.
Counts the number of set bits in the binary representation of this Long number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Byte number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Short number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this UByte number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this UInt number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this ULong number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this UShort number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Long number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.
Counts the number of consecutive least significant bits that are zero in the binary representation of this Long number.
Enables the use of the unary --
operator for BigDecimal instances.
Enables the use of the --
operator for BigInteger instances.
Enables the use of the /
operator for BigDecimal instances.
Enables the use of the /
operator for BigInteger instances.
Returns an array containing the specified Double numbers.
Returns an array containing the specified Double numbers.
Returns an array containing the specified Double numbers.
Returns an array containing the specified Double numbers.
Returns an array containing the specified Double numbers.
Returns an array containing the specified Double numbers.
Returns an empty array of the specified type T.
Returns an empty array of the specified type T.
Returns an empty array of the specified type T.
Returns an enum entry with specified name.
Returns an enum entry with specified name.
Returns an enum entry with specified name.
Returns an enum entry with specified name.
Returns an enum entry with specified name.
Returns an enum entry with specified name.
Returns an array containing enum T entries.
Returns an array containing enum T entries.
Returns an array containing enum T entries.
Returns an array containing enum T entries.
Returns an array containing enum T entries.
Returns an array containing enum T entries.
Returns an array containing the specified Float numbers.
Returns an array containing the specified Float numbers.
Returns an array containing the specified Float numbers.
Returns an array containing the specified Float numbers.
Returns an array containing the specified Float numbers.
Returns an array containing the specified Float numbers.
Divides this value by the other value, flooring the result to an integer that is closer to negative infinity.
Returns the Double value corresponding to a given bit representation.
Returns the Float value corresponding to a given bit representation.
Returns the Double value corresponding to a given bit representation.
Returns the Float value corresponding to a given bit representation.
Returns the Double value corresponding to a given bit representation.
Returns the Float value corresponding to a given bit representation.
Returns the Double value corresponding to a given bit representation.
Returns the Float value corresponding to a given bit representation.
Returns the Double value corresponding to a given bit representation.
Returns the Float value corresponding to a given bit representation.
Returns the Double value corresponding to a given bit representation.
Returns the Float value corresponding to a given bit representation.
Returns the encapsulated value if this instance represents success or the result of onFailure function for the encapsulated Throwable exception if it is failure.
Returns the encapsulated value if this instance represents success or throws the encapsulated Throwable exception if it is failure.
An extension to delegate a read-only property of type T to an instance of Lazy.
An extension operator that allows delegating a read-only property of type V to a property reference to a property of type V or its subtype.
An extension operator that allows delegating a read-only member or extension property of type V to a property reference to a member or extension property of type V or its subtype.
Returns a hash code value for the object or zero if the object is null
.
Enables the use of the unary ++
operator for BigDecimal instances.
Enables the use of the ++
operator for BigInteger instances.
Returns an array containing the specified Int numbers.
Returns an array containing the specified Int numbers.
Returns an array containing the specified Int numbers.
Returns an array containing the specified Int numbers.
Returns an array containing the specified Int numbers.
Returns an array containing the specified Int numbers.
Inverts the bits including the sign bit in this value.
Initiates a call to this deep recursive function, forming a root of the call tree.
Returns true
if the argument is a finite floating-point value; returns false
otherwise (for NaN
and infinity arguments).
Returns true
if the argument is a finite floating-point value; returns false
otherwise (for NaN
and infinity arguments).
Returns true
if the argument is a finite floating-point value; returns false
otherwise (for NaN
and infinity arguments).
Returns true
if the argument is a finite floating-point value; returns false
otherwise (for NaN
and infinity arguments).
Returns true
if the argument is a finite floating-point value; returns false
otherwise (for NaN
and infinity arguments).
Returns true
if the argument is a finite floating-point value; returns false
otherwise (for NaN
and infinity arguments).
Returns true
if this value is infinitely large in magnitude.
Returns true
if this value is infinitely large in magnitude.
Returns true
if this value is infinitely large in magnitude.
Returns true
if this value is infinitely large in magnitude.
Returns true
if this value is infinitely large in magnitude.
Returns true
if this value is infinitely large in magnitude.
Returns true
if the specified number is a Not-a-Number (NaN) value, false
otherwise.
Returns true
if the specified number is a Not-a-Number (NaN) value, false
otherwise.
Returns true
if the specified number is a Not-a-Number (NaN) value, false
otherwise.
Returns true
if the specified number is a Not-a-Number (NaN) value, false
otherwise.
Returns true
if the specified number is a Not-a-Number (NaN) value, false
otherwise.
Returns true
if the specified number is a Not-a-Number (NaN) value, false
otherwise.
expect fun <T> lazy(initializer: () -> T): Lazy<T>
Creates a new instance of the Lazy that uses the specified initialization function initializer and the default thread-safety mode LazyThreadSafetyMode.SYNCHRONIZED. The lock used is both platform- and implementation- specific detail.
expect fun <T> lazy(lock: Any?, initializer: () -> T): Lazy<T>
Creates a new instance of the Lazy that uses the specified initialization function initializer.
Creates a new instance of the Lazy that uses the specified initialization function initializer and thread-safety mode.
actual fun <T> lazy(initializer: () -> T): Lazy<T>
actual fun <T> lazy(lock: Any?, initializer: () -> T): Lazy<T>
Creates a new instance of the Lazy that uses the specified initialization function initializer.
actual fun <T> lazy(initializer: () -> T): Lazy<T>
actual fun <T> lazy(lock: Any?, initializer: () -> T): Lazy<T>
Creates a new instance of the Lazy that uses the specified initialization function initializer and thread-safety mode.
actual fun <T> lazy(initializer: () -> T): Lazy<T>
actual fun <T> lazy(lock: Any?, initializer: () -> T): Lazy<T>
Creates a new instance of the Lazy that uses the specified initialization function initializer and thread-safety mode.
actual fun <T> lazy(initializer: () -> T): Lazy<T>
actual fun <T> lazy(lock: Any?, initializer: () -> T): Lazy<T>
Creates a new instance of the Lazy that uses the specified initialization function initializer.
actual fun <T> lazy(initializer: () -> T): Lazy<T>
actual fun <T> lazy(lock: Any?, initializer: () -> T): Lazy<T>
Creates a new instance of the Lazy that uses the specified initialization function initializer.
Creates a new instance of the Lazy that is already initialized with the specified value.
inline fun <T, R> T.let(block: (T) -> R): R
Calls the specified function block with this
value as its argument and returns its result.
Returns an array containing the specified Long numbers.
Returns an array containing the specified Long numbers.
Returns an array containing the specified Long numbers.
Returns an array containing the specified Long numbers.
Returns an array containing the specified Long numbers.
Returns an array containing the specified Long numbers.
Returns the encapsulated result of the given transform function applied to the encapsulated value if this instance represents success or the original encapsulated Throwable exception if it is failure.
Returns the encapsulated result of the given transform function applied to the encapsulated value if this instance represents success or the original encapsulated Throwable exception if it is failure.
Enables the use of the -
operator for BigDecimal instances.
Enables the use of the -
operator for BigInteger instances.
Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
Performs the given action on the encapsulated Throwable exception if this instance represents failure. Returns the original Result
unchanged.
Performs the given action on the encapsulated value if this instance represents success. Returns the original Result
unchanged.
Performs a bitwise OR operation between the two values.
Concatenates this string with the string representation of the given other object. If either the receiver or the other object are null, they are represented as the string "null".
Concatenates this string with the string representation of the given other object. If either the receiver or the other object are null, they are represented as the string "null".
Enables the use of the +
operator for BigDecimal instances.
Enables the use of the +
operator for BigInteger instances.
Concatenates this string with the string representation of the given other object. If either the receiver or the other object are null, they are represented as the string "null".
Concatenates this string with the string representation of the given other object. If either the receiver or the other object are null, they are represented as the string "null".
Concatenates this string with the string representation of the given other object. If either the receiver or the other object are null, they are represented as the string "null".
Returns the encapsulated result of the given transform function applied to the encapsulated Throwable exception if this instance represents failure or the original encapsulated value if it is success.
Returns the encapsulated result of the given transform function applied to the encapsulated Throwable exception if this instance represents failure or the original encapsulated value if it is success.
Enables the use of the %
operator for BigDecimal instances.
Enables the use of the %
operator for BigInteger instances.
Executes the given function action specified number of times.
Rotates the binary representation of this Byte number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Long number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Short number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this UByte number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this UInt number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this ULong number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this UShort number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Long number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Long number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Long number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Long number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Long number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.
Rotates the binary representation of this Byte number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Long number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Short number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this UByte number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this UInt number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this ULong number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this UShort number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Long number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Long number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Long number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Long number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
Rotates the binary representation of this Long number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.
inline fun <R> run(block: () -> R): R
Calls the specified function block and returns its result.
inline fun <T, R> T.run(block: T.() -> R): R
Calls the specified function block with this
value as its receiver and returns its result.
Calls the specified function block and returns its encapsulated result if invocation was successful, catching any Throwable exception that was thrown from the block function execution and encapsulating it as a failure.
Calls the specified function block with this
value as its receiver and returns its encapsulated result if invocation was successful, catching any Throwable exception that was thrown from the block function execution and encapsulating it as a failure.
An extension operator that allows delegating a mutable property of type V to a property reference to a mutable property of the same type V.
An extension operator that allows delegating a mutable member or extension property of type V to a property reference to a member or extension mutable property of the same type V.
Shifts this value left by the n number of bits.
Returns an array containing the specified Short numbers.
Returns an array containing the specified Short numbers.
Returns an array containing the specified Short numbers.
Returns an array containing the specified Short numbers.
Returns an array containing the specified Short numbers.
Returns an array containing the specified Short numbers.
Shifts this value right by the n number of bits, filling the leftmost bits with copies of the sign bit.
Returns the detailed description of this throwable with its stack trace.
Returns the detailed description of this throwable with its stack trace.
Returns the detailed description of this throwable with its stack trace.
Returns the detailed description of this throwable with its stack trace.
Returns the detailed description of this throwable with its stack trace.
Returns the detailed description of this throwable with its stack trace.
inline fun <R> suspend(noinline block: suspend () -> R): suspend () -> R
A functional type builder that ensures the given block has a suspend
modifier and can be used as a suspend function.
Executes the given function block while holding the monitor of the given object lock.
Returns a number having a single bit set in the position of the most significant set bit of this Byte number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Short number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this UByte number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this UInt number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this ULong number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this UShort number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the most significant set bit of this Long number, or zero, if this number is zero.
Returns this
value if it satisfies the given predicate or null
, if it doesn't.
Returns a number having a single bit set in the position of the least significant set bit of this Byte number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Short number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this UByte number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this UInt number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this ULong number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this UShort number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Long number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.
Returns a number having a single bit set in the position of the least significant set bit of this Long number, or zero, if this number is zero.
Returns this
value if it does not satisfy the given predicate or null
, if it does.
Enables the use of the *
operator for BigDecimal instances.
Enables the use of the *
operator for BigInteger instances.
Creates a tuple of type Pair from this and that.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.
Converts this pair into a list.
Converts this triple into a list.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN
values exact layout.
Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN
values exact layout.
Returns a string representation of the object. Can be called with a null receiver, in which case it returns the string "null".
Returns a string representation of the object. Can be called with a null receiver, in which case it returns the string "null".
Returns a string representation of the object. Can be called with a null receiver, in which case it returns the string "null".
Returns a string representation of the object. Can be called with a null receiver, in which case it returns the string "null".
Returns a string representation of the object. Can be called with a null receiver, in which case it returns the string "null".
Creates a new array of the specified size, where each element is calculated by calling the specified init function.
Creates a new array of the specified size, where each element is calculated by calling the specified init function.
Creates a new array of the specified size, where each element is calculated by calling the specified init function.
Enables the use of the unary -
operator for BigDecimal instances.
Enables the use of the unary -
operator for BigInteger instances.
Executes the given block function on this resource and then closes it down correctly whether an exception is thrown or not.
Creates a new array of the specified size, where each element is calculated by calling the specified init function.
inline fun <T, R> with(receiver: T, block: T.() -> R): R
Calls the specified function block with the given receiver as its receiver and returns its result.
Performs a bitwise XOR operation between the two values.