Results

@frozen
public struct Results<Element> : Equatable where Element : RealmCollectionValue
extension Results: RealmSubscribable
extension Results: RealmCollection
extension Results: Encodable where Element: Encodable

Results is an auto-updating container type in Realm returned from object queries.

Results can be queried with the same predicates as List<Element>, and you can chain queries to further filter query results.

Results always reflect the current state of the Realm on the current thread, including during write transactions on the current thread. The one exception to this is when using for...in enumeration, which will always enumerate over the objects which matched the query when the enumeration is begun, even if some of them are deleted or modified to be excluded by the filter during the enumeration.

Results are lazily evaluated the first time they are accessed; they only run queries when the result of the query is requested. This means that chaining several temporary Results to sort and filter your data does not perform any unnecessary work processing the intermediate state.

Once the results have been evaluated or a notification block has been added, the results are eagerly kept up-to-date, with the work done to keep them up-to-date done on a background thread whenever possible.

Results instances cannot be directly instantiated.

Show on GitHub

  • A human-readable description of the objects represented by the results.

    Declaration

    Swift

    public var description: String { get }
    Show on GitHub

  • The type of the objects described by the results.

    Declaration

    Swift

    public typealias ElementType = Element
    Show on GitHub

Properties

  • The Realm which manages this results. Note that this property will never return nil.

    Declaration

    Swift

    public var realm: Realm? { get }
    Show on GitHub

  • Indicates if the results are no longer valid.

    The results becomes invalid if invalidate() is called on the containing realm. An invalidated results can be accessed, but will always be empty.

    Declaration

    Swift

    public var isInvalidated: Bool { get }
    Show on GitHub

  • The number of objects in the results.

    Declaration

    Swift

    public var count: Int { get }
    Show on GitHub

Index Retrieval

  • Returns the index of the given object in the results, or nil if the object is not present.

    Declaration

    Swift

    public func index(of object: Element) -> Int?
    Show on GitHub

  • Returns the index of the first object matching the predicate, or nil if no objects match.

    Declaration

    Swift

    public func index(matching predicate: NSPredicate) -> Int?

    Parameters

    predicate

    The predicate with which to filter the objects.
    Show on GitHub

Object Retrieval

  • Returns the object at the given index.

    Declaration

    Swift

    public subscript(position: Int) -> Element { get }

    Parameters

    index

    The index.
    Show on GitHub

  • Returns the first object in the results, or nil if the results are empty.

    Declaration

    Swift

    public var first: Element? { get }
    Show on GitHub

  • Returns the last object in the results, or nil if the results are empty.

    Declaration

    Swift

    public var last: Element? { get }
    Show on GitHub

  • Returns an array containing the objects in the results at the indexes specified by a given index set.

    Warning

    warning Throws if an index supplied in the IndexSet is out of bounds.

    Declaration

    Swift

    public func objects(at indexes: IndexSet) -> [Element]

    Parameters

    indexes

    The indexes in the results to select objects from.
    Show on GitHub

KVC

  • Returns an Array containing the results of invoking valueForKey(_:) with key on each of the results.

    Declaration

    Swift

    public func value(forKey key: String) -> Any?

    Parameters

    key

    The name of the property whose values are desired.
    Show on GitHub

  • Returns an Array containing the results of invoking valueForKeyPath(_:) with keyPath on each of the results.

    Declaration

    Swift

    public func value(forKeyPath keyPath: String) -> Any?

    Parameters

    keyPath

    The key path to the property whose values are desired.
    Show on GitHub

  • Invokes setValue(_:forKey:) on each of the objects represented by the results using the specified value and key.

    Warning

    This method may only be called during a write transaction.

    Declaration

    Swift

    public func setValue(_ value: Any?, forKey key: String)

    Parameters

    value

    The object value.
    key

    The name of the property whose value should be set on each object.
    Show on GitHub

Filtering

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

    Declaration

    Swift

    public func filter(_ predicate: NSPredicate) -> Results<Element>

    Parameters

    predicate

    The predicate with which to filter the objects.
    Show on GitHub

Sorting

  • Returns a Results containing the objects represented by the results, but sorted.

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

    Warning

    Collections may only be sorted by properties of boolean, Date, NSDate, single and double-precision floating point, integer, and string types.

    Declaration

    Swift

    public func sorted(byKeyPath keyPath: String, ascending: Bool = true) -> Results<Element>

    Parameters

    keyPath

    The key path to sort by.
    ascending

    The direction to sort in.
    Show on GitHub

  • Returns a Results containing the objects represented by the results, but sorted.

    Warning

    Collections may only be sorted by properties of boolean, Date, NSDate, single and double-precision floating point, integer, and string types.

    See

    sorted(byKeyPath:ascending:)

    Declaration

    Swift

    public func sorted<S: Sequence>(by sortDescriptors: S) -> Results<Element>
    where S.Iterator.Element == SortDescriptor

    Parameters

    sortDescriptors

    A sequence of SortDescriptors to sort by.
    Show on GitHub

  • Returns a Results containing distinct objects based on the specified key paths

    Declaration

    Swift

    public func distinct<S: Sequence>(by keyPaths: S) -> Results<Element>
    where S.Iterator.Element == String

    Parameters

    keyPaths

    The key paths used produce distinct results
    Show on GitHub

Aggregate Operations

  • Returns the minimum (lowest) value of the given property among all the results, or nil if the results are empty.

    Warning

    Only a property whose type conforms to the MinMaxType protocol can be specified.

    Declaration

    Swift

    public func min<T>(ofProperty property: String) -> T? where T : MinMaxType

    Parameters

    property

    The name of a property whose minimum value is desired.
    Show on GitHub

  • Returns the maximum (highest) value of the given property among all the results, or nil if the results are empty.

    Warning

    Only a property whose type conforms to the MinMaxType protocol can be specified.

    Declaration

    Swift

    public func max<T>(ofProperty property: String) -> T? where T : MinMaxType

    Parameters

    property

    The name of a property whose minimum value is desired.
    Show on GitHub

  • Returns the sum of the values of a given property over all the results.

    Warning

    Only a property whose type conforms to the AddableType protocol can be specified.

    Declaration

    Swift

    public func sum<T>(ofProperty property: String) -> T where T : AddableType

    Parameters

    property

    The name of a property whose values should be summed.
    Show on GitHub

  • Returns the average value of a given property over all the results, or nil if the results are empty.

    Warning

    Only the name of a property whose type conforms to the AddableType protocol can be specified.

    Declaration

    Swift

    public func average<T>(ofProperty property: String) -> T? where T : AddableType

    Parameters

    property

    The name of a property whose average value should be calculated.
    Show on GitHub

Notifications

  • 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 dogs = 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.append(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.

    Warning

    This method cannot be called during a write transaction, or when the containing Realm is read-only.

    Declaration

    Swift

    public func observe(on queue: DispatchQueue? = nil,
                    _ block: @escaping (RealmCollectionChange<Results>) -> Void) -> NotificationToken

    Parameters

    queue

    The serial dispatch queue to receive notification on. If nil, notifications are delivered to the current thread.
    block

    The block to be called whenever a change occurs.

    Return Value

    A token which must be held for as long as you want updates to be delivered.

    Show on GitHub

  • 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 dogs = 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.append(dog)
}
// end of run loop execution context

    If no key paths are given, the block will be executed on any insertion, modification, or deletion for all object properties and the properties of any nested, linked objects. If a key path or key paths are provided, then the block will be called for changes which occur only on the provided key paths. For example, if:

    class Dog: Object {
    @Persisted var name: String
    @Persisted var age: Int
    @Persisted var toys: List<Toy>
}
// ...
let dogs = realm.objects(Dog.self)

let token = dogs.observe(keyPaths: ["name"]) { changes in
    switch changes {
    case .initial(let dogs):
       // ...
    case .update:
       // This case is hit:
       // - after the token is intialized
       // - when the name property of an object in the
       // collection is modified
       // - when an element is inserted or removed
       //   from the collection.
       // This block is not triggered:
       // - when a value other than name is modified on
       //   one of the elements.
    case .error:
        // ...
    }
}
// end of run loop execution context
    • If the observed key path were ["toys.brand"], then any insertion or deletion to the toys list on any of the collection’s elements would trigger the block. Changes to the brand value on any Toy that is linked to a Dog in this collection will trigger the block. Changes to a value other than brand on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would also trigger a notification.

    • If the above example observed the ["toys"] key path, then any insertion, deletion, or modification to the toys list for any element in the collection would trigger the block. Changes to any value on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would still trigger a notification.

    Note

    Multiple notification tokens on the same object which filter for separate key paths do not filter exclusively. If one key path change is satisfied for one notification token, then all notification token blocks for that object will execute.

    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.

    Warning

    This method cannot be called during a write transaction, or when the containing Realm is read-only.

    Declaration

    Swift

    public func observe(keyPaths: [String]? = nil,
                    on queue: DispatchQueue? = nil,
                    _ block: @escaping (RealmCollectionChange<Results>) -> Void) -> NotificationToken

    Parameters

    keyPaths

    Only properties contained in the key paths array will trigger the block when they are modified. If nil, notifications will be delivered for any property change on the object. String key paths which do not correspond to a valid a property will throw an exception. See description above for more detail on linked properties.
    queue

    The serial dispatch queue to receive notification on. If nil, notifications are delivered to the current thread.
    block

    The block to be called whenever a change occurs.

    Return Value

    A token which must be held for as long as you want updates to be delivered.

    Show on GitHub

  • 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 dogs = 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.append(dog)
}
// end of run loop execution context

    If no key paths are given, the block will be executed on any insertion, modification, or deletion for all object properties and the properties of any nested, linked objects. If a key path or key paths are provided, then the block will be called for changes which occur only on the provided key paths. For example, if:

    class Dog: Object {
    @Persisted var name: String
    @Persisted var age: Int
    @Persisted var toys: List<Toy>
}
// ...
let dogs = realm.objects(Dog.self)

let token = dogs.observe(keyPaths: [\Dog.name]) { changes in
    switch changes {
    case .initial(let dogs):
       // ...
    case .update:
       // This case is hit:
       // - after the token is intialized
       // - when the name property of an object in the
       // collection is modified
       // - when an element is inserted or removed
       //   from the collection.
       // This block is not triggered:
       // - when a value other than name is modified on
       //   one of the elements.
    case .error:
        // ...
    }
}
// end of run loop execution context
    • If the observed key path were [\Dog.toys.brand], then any insertion or deletion to the toys list on any of the collection’s elements would trigger the block. Changes to the brand value on any Toy that is linked to a Dog in this collection will trigger the block. Changes to a value other than brand on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would also trigger a notification.

    • If the above example observed the [\Dog.toys] key path, then any insertion, deletion, or modification to the toys list for any element in the collection would trigger the block. Changes to any value on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would still trigger a notification.

    Note

    Multiple notification tokens on the same object which filter for separate key paths do not filter exclusively. If one key path change is satisfied for one notification token, then all notification token blocks for that object will execute.

    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.

    Warning

    This method cannot be called during a write transaction, or when the containing Realm is read-only.

    Declaration

    Swift

    public func observe<T: ObjectBase>(keyPaths: [PartialKeyPath<T>],
                                   on queue: DispatchQueue? = nil,
                                   _ block: @escaping (RealmCollectionChange<Results>) -> Void) -> NotificationToken

    Parameters

    keyPaths

    Only properties contained in the key paths array will trigger the block when they are modified. If nil, notifications will be delivered for any property change on the object. String key paths which do not correspond to a valid a property will throw an exception. See description above for more detail on linked properties.
    queue

    The serial dispatch queue to receive notification on. If nil, notifications are delivered to the current thread.
    block

    The block to be called whenever a change occurs.

    Return Value

    A token which must be held for as long as you want updates to be delivered.

    Show on GitHub

Frozen Objects

Results

  • A publisher that emits Void each time the collection changes.

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

    Declaration

    Swift

    public var objectWillChange: RealmPublishers.WillChange<Results> { get }
    Show on GitHub

Sequence Support

Collection Support

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

    Declaration

    Swift

    public var startIndex: Int { get }
    Show on GitHub

  • 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().

    Declaration

    Swift

    public var endIndex: Int { get }
    Show on GitHub

  • Declaration

    Swift

    public func index(after i: Int) -> Int
    Show on GitHub

  • Declaration

    Swift

    public func index(before i: Int) -> Int
    Show on GitHub

Available where Element: Encodable

Available where Element: ObjectBase

  • Returns a Results containing distinct objects based on the specified key paths

    Declaration

    Swift

    public func distinct<S: Sequence>(by keyPaths: S) -> Results<Element>
    where S.Iterator.Element == PartialKeyPath<Element>

    Parameters

    keyPaths

    The key paths used produce distinct results
    Show on GitHub