MutableSet

The Realm which manages the set, or nil if the set is unmanaged.

Indicates if the set can no longer be accessed.

Creates a MutableSet that holds Realm model objects of type Element.

Returns the number of objects in this MutableSet.

Returns an Array containing the results of invoking valueForKey(_:) using key on each of the collection’s objects.

Returns an Array containing the results of invoking valueForKeyPath(_:) using keyPath on each of the collection’s objects.

Invokes setValue(_:forKey:) on each of the collection’s objects using the specified value and key.

Returns a Results containing all objects matching the given predicate in the set.

Returns a Boolean value indicating whether the Set contains the given object.

Returns a Boolean value that indicates whether this set is a subset of the given set.

Returns a Boolean value that indicates whether this set intersects with another given set.

Returns a Results containing the objects in the set, but sorted.

Objects are sorted based on the values of the given key path. For example, to sort a set of Students from youngest to oldest based on their age property, you might call students.sorted(byKeyPath: "age", ascending: true).

Returns a Results containing the objects in the set, but sorted.

Returns the minimum (lowest) value of the given property among all the objects in the set, or nil if the set is empty.

Returns the maximum (highest) value of the given property among all the objects in the set, or nil if the set is empty.

Returns the sum of the values of a given property over all the objects in the set.

Returns the average value of a given property over all the objects in the set, or nil if the set is empty.

Inserts an object to the set if not already present.

Inserts the given sequence of objects into the set if not already present.

Removes an object in the set if present. The object is not removed from the Realm that manages it.

Removes all objects from the set. The objects are not removed from the Realm that manages them.

Mutates the set in place with the elements that are common to both this set and the given sequence.

Mutates the set in place and removes the elements of the given set from this set.

Inserts the elements of the given sequence into the set.

Registers a block to be called each time the collection changes.

The block will be asynchronously called with the initial results, and then called again after each write transaction which changes either any of the objects in the collection, or which objects are in the collection.

The change parameter that is passed to the block reports, in the form of indices within the collection, which of the objects were added, removed, or modified during each write transaction. See the RealmCollectionChange documentation for more information on the change information supplied and an example of how to use it to update a UITableView.

At the time when the block is called, the collection will be fully evaluated and up-to-date, and as long as you do not perform a write transaction on the same thread or explicitly call realm.refresh(), accessing it will never perform blocking work.

If no queue is given, notifications are delivered via the standard run loop, and so can’t be delivered while the run loop is blocked by other activity. If a queue is given, notifications are delivered to that queue instead. When notifications can’t be delivered instantly, multiple notifications may be coalesced into a single notification. This can include the notification with the initial collection.

For example, the following code performs a write transaction immediately after adding the notification block, so there is no opportunity for the initial notification to be delivered first. As a result, the initial notification will reflect the state of the Realm after the write transaction.

let results = realm.objects(Dog.self)
print("dogs.count: \(dogs?.count)") // => 0
let token = dogs.observe { changes in
    switch changes {
    case .initial(let dogs):
        // Will print "dogs.count: 1"
        print("dogs.count: \(dogs.count)")
        break
    case .update:
        // Will not be hit in this example
        break
    case .error:
        break
    }
}
try! realm.write {
    let dog = Dog()
    dog.name = "Rex"
    person.dogs.insert(dog)
}
// end of run loop execution context

You must retain the returned token for as long as you want updates to be sent to the block. To stop receiving updates, call invalidate() on the token.

Returns a human-readable description of the objects contained in the MutableSet.

A publisher that emits Void each time the collection changes.

Despite the name, this actually emits after the collection has changed.

The type of the objects stored within the set.

Returns a RLMIterator that yields successive elements in the MutableSet.

The position of the first element in a non-empty collection. Identical to endIndex in an empty collection.

The collection’s “past the end” position. endIndex is not a valid argument to subscript, and is always reachable from startIndex by zero or more applications of successor().

Returns the minimum (lowest) value in the set, or nil if the set is empty.

Returns the maximum (highest) value in the set, or nil if the set is empty.

Returns the sum of the values in the set.

Returns the average of the values in the set, or nil if the set is empty.