Realm Kotlin SDK/io.realm.kotlin.types/RealmSet

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.

Properties

size

abstract override val size: Int

Functions

add

abstract override fun add(element: E): Boolean

addAll

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

asFlow

abstract fun asFlow(keyPaths: List<String>? = null): Flow<SetChange<E>>

Observes changes to the RealmSet. The Flow will emit InitialSet once subscribed, and then UpdatedSet on every change to the set. The flow will continue running indefinitely until canceled or until the parent object is deleted.

clear

abstract override fun clear()

contains

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

containsAll

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

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. This is a deep copy that will copy all referenced objects.

isEmpty

abstract override fun isEmpty(): Boolean

iterator

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

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.

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

toRealmDictionary

fun <T> Iterable<Pair<String, T>>.toRealmDictionary(): RealmDictionary<T>

Instantiates an unmanaged RealmDictionary containing all the elements of this iterable of Pairs of Strings and Ts.

fun <T> RealmDictionaryEntrySet<T>.toRealmDictionary(): RealmDictionary<T>

Instantiates an unmanaged RealmDictionary containing all the elements of the receiver RealmDictionaryEntrySet.

toRealmList

fun <T> Iterable<T>.toRealmList(): RealmList<T>

Instantiates an unmanaged RealmList containing all the elements of this iterable.

toRealmSet

fun <T> Iterable<T>.toRealmSet(): RealmSet<T>

Instantiates an unmanaged RealmSet containing all the elements of this iterable.