List

Element type contained in this collection.

Returns the object at the given index on get. Replaces the object at the given index on set.

The Realm the objects in this List belong to, or nil if the List’s owning object does not belong to a Realm (the List is standalone).

Indicates if the List can no longer be accessed.

Creates a List that holds objects of type T.

Returns the index of the given object, or nil if the object is not in the List.

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

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

Returns the first object in the List, or nil if empty.

Returns the last object in the List, or nil if empty.

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 Results containing elements that match the given predicate.

Returns Results containing elements that match the given predicate.

Returns Results containing elements sorted by the given property.

Returns Results with elements sorted by the given sort descriptors.

Returns the minimum value of the given property.

Returns the maximum value of the given property.

Returns the sum of the given property for objects in the List.

Returns the average of the given property for objects in the List.

Appends the given object to the end of the List. If the object is from a different Realm it is copied to the List’s Realm.

Appends the objects in the given sequence to the end of the List.

Inserts the given object at the given index.

Removes the object at the given index from the List. Does not remove the object from the Realm.

Removes the last object in the List. Does not remove the object from the Realm.

Removes all objects from the List. Does not remove the objects from the Realm.

Replaces an object at the given index with a new object.

Moves the object at the given source index to the given destination index.

Exchanges the objects in the List at given indexes.

Register a block to be called each time the List changes.

The block will be asynchronously called with the initial list, and then called again after each write transaction which changes the list or any of the items in the list.

The block is called on the same thread as it was added on, and can only be added on threads which are currently within a run loop. Unless you are specifically creating and running a run loop on a background thread, this will normally only be the main thread.

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 list. 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 person = realm.objects(Person).first!
print("dogs.count: \(person.dogs.count)") // => 0
let token = person.dogs.addNotificationBlock { (dogs: List) in
    // Only fired once for the example
    print("dogs.count: \(dogs.count)") // will only print "dogs.count: 1"
}
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.

Register a block to be called each time the List changes.

The block will be asynchronously called with the initial list, and then called again after each write transaction which changes the list or any of the items in the list.

This version of this method reports which of the objects in the List were added, removed, or modified in each write transaction as indices within the List. See the RealmCollectionChange documentation for more information on the change information supplied and an example of how to use it to update a UITableView.

The block is called on the same thread as it was added on, and can only be added on threads which are currently within a run loop. Unless you are specifically creating and running a run loop on a background thread, this will normally only be the main thread.

Notifications can’t be delivered as long as 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 list. 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, and will not include change information.

let person = realm.objects(Person).first!
print("dogs.count: \(person.dogs.count)") // => 0
let token = person.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 a GeneratorOf<T> that yields successive elements in the List.

Replace the given subRange of elements with newElements.

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