kotlin.util.Standard.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-js-library Show documentation

There is a newer version: 1.0.7

package kotlin

/**
 * An exception is thrown to indicate that a method body remains to be implemented.
 */
public class NotImplementedError(message: String = "An operation is not implemented.") : Error(message)

/**
 * Always throws [NotImplementedError] stating that operation is not implemented.
 */
public fun TODO(): Nothing = throw NotImplementedError()

/**
 * Always throws [NotImplementedError] stating that operation is not implemented.
 *
 * @param reason a string explaining why the implementation is missing.
 */
public fun TODO(reason: String): Nothing = throw NotImplementedError("An operation is not implemented: $reason")


/**
 * Creates a tuple of type [Pair] from this and [that].
 *
 * This can be useful for creating [Map] literals with less noise, for example:
 * @sample test.collections.MapTest.createUsingTo
 */
public fun  A.to(that: B): Pair = Pair(this, that)

/**
 * Calls the specified function [f] and returns its result.
 */
public inline fun  run(f: () -> R): R = f()

/**
 * Calls the specified function [f] with `this` value as its receiver and returns its result.
 */
public inline fun  T.run(f: T.() -> R): R = f()

/**
 * Calls the specified function [f] with the given [receiver] as its receiver and returns its result.
 */
public inline fun  with(receiver: T, f: T.() -> R): R = receiver.f()

/**
 * Calls the specified function [f] with `this` value as its receiver and returns `this` value.
 */
public inline fun  T.apply(f: T.() -> Unit): T { f(); return this }

/**
 * Calls the specified function [f] with `this` value as its argument and returns its result.
 */
public inline fun  T.let(f: (T) -> R): R = f(this)