RealmSet

interface RealmSet<E> : MutableSet<E> , Deleteable

RealmSet is a collection that contains no duplicate elements.

Similarly to RealmLists, a RealmSet can operate in managed and unmanaged modes. In managed mode a RealmSet persists all its contents inside a realm whereas in unmanaged mode it functions like a MutableSet.

Managed RealmSets can only be created by Realm and will automatically update their content whenever the underlying Realm is updated. Managed RealmSets can only be accessed using the getter that points to a RealmSet field of a RealmObject.

Parameters

the type of elements contained in the RealmSet.

Functions

add

abstract override fun add(element: E): Boolean

addAll

abstract override fun addAll(elements: Collection<E>): Boolean

asFlow

abstract fun asFlow(): Flow<SetChange<E>>

Observes changes to the RealmSet.

clear

abstract override fun clear()

contains

abstract operator override fun contains(element: E): Boolean

containsAll

abstract override fun containsAll(elements: Collection<E>): Boolean

isEmpty

abstract override fun isEmpty(): Boolean

iterator

abstract operator override fun iterator(): MutableIterator<E>

remove

abstract override fun remove(element: E): Boolean

removeAll

abstract override fun removeAll(elements: Collection<E>): Boolean

retainAll

abstract override fun retainAll(elements: Collection<E>): Boolean

Properties

size

abstract override val size: Int

Extensions

copyFromRealm

inline fun <T : RealmObject> RealmSet<T>.copyFromRealm(depth: UInt = UInt.MAX_VALUE): Set<T>

Makes an unmanaged in-memory copy of the elements in a managed RealmSet.

query

fun <T : BaseRealmObject> RealmSet<T>.query(filter: String = TRUE_PREDICATE, vararg arguments: Any?): RealmQuery<T>

Query the objects in a set by filter and arguments.