Results

The type of the objects contained in the collection.

Returns the object at the given index.

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

Indicates if the results collection is no longer valid.

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

The number of objects in the results collection.

Returns the index of an object in the results collection, or nil if the object is not present.

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

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

Returns the first object in the results collection, or nil if the collection is empty.

Returns the last object in the results collection, or nil if the collection is empty.

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

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

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

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

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

Returns a Results containing the objects in the results collection, but sorted.

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

Returns a Results containing the objects in the results collection, but sorted.

Returns the minimum (lowest) value of the given property among all the objects represented by the collection.

Returns the maximum (highest) value of the given property among all the objects represented by the collection.

Returns the sum of the values of a given property over all the objects represented by the collection.

Returns the average value of a given property over all the objects represented by the collection.

Registers a block to be called each time the results 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.

Notifications are delivered via the standard run loop, and so can’t be delivered while the run loop is blocked by other activity. 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.addNotificationBlock { (changes: RealmCollectionChange) 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 continue to be sent to the block. To stop receiving updates, call stop() on the token.

Returns an RLMGenerator that yields successive elements in the results.

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