kotlin-stdlib/kotlin.collections/remove

remove

inline fun <K, V> MutableMap<out K, V>.remove(key: K): V?(source)

Removes the specified key and its corresponding value from this map.

Since Kotlin

1.0

Return

the previous value associated with the key, or null if the key was not present in the map.

Allows to overcome type-safety restriction of remove that requires to pass a key of type K.

inline fun <T> MutableCollection<out T>.remove(element: T): Boolean(source)

Removes a single instance of the specified element from this collection, if it is present.

Allows to overcome type-safety restriction of remove that requires to pass an element of type E.

Since Kotlin

1.0

Return

true if the element has been successfully removed; false if it was not present in the collection.

inline fun <T> MutableList<T>.remove(index: Int): T(source)

Deprecated (with error)

Use removeAt(index) instead.

Replace with

removeAt(index)
Content copied to clipboard

Removes the element at the specified index from this list. In Kotlin one should use the MutableList.removeAt function instead.

Since Kotlin

1.0
inline fun <K, V> MutableMap<out K, out V>.remove(key: K, value: V): Boolean(source)

Removes the entry for the specified key only if it is currently mapped to the specified value.

Since Kotlin

1.2