Results

public final class Results<T: Object>: ResultsBase

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

Results can be queried with the same predicates as List<T> 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 initially lazily evaluated, and 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 extra 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 cannot be created directly.

Properties

  • Element type contained in this collection.

    Declaration

    Swift

    public typealias Element = T
    Show on GitHub

  • Returns the object at the given index.

    Declaration

    Swift

    public subscript(index: Int) -> T

    Parameters

    index

    The index.

    Return Value

    The object at the given index.

    Show on GitHub

  • Returns the Realm these results are associated with. Despite returning an Optional<Realm> in order to conform to RealmCollectionType, it will always return .Some() since a Results cannot exist independently from a Realm.

    Declaration

    Swift

    public var realm: Realm? { return Realm(rlmResults.realm) }
    Show on GitHub

  • Returns the number of objects in these results.

    Declaration

    Swift

    public var count: Int { return Int(rlmResults.count) }
    Show on GitHub

Index Retrieval

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

    Declaration

    Swift

    public func indexOf(object: T) -> Int?

    Parameters

    object

    The object whose index is being queried.

    Return Value

    The index of the given object, or nil if the object is not in the results.

    Show on GitHub

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

    Declaration

    Swift

    public func indexOf(predicate: NSPredicate) -> Int?

    Parameters

    predicate

    The predicate to filter the objects.

    Return Value

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

    Show on GitHub

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

    Declaration

    Swift

    public func indexOf(predicateFormat: String, _ args: AnyObject...) -> Int?

    Parameters

    predicateFormat

    The predicate format string which can accept variable arguments.

    Return Value

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

    Show on GitHub

Object Retrieval

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

    Declaration

    Swift

    public var first: T? { return unsafeBitCast(rlmResults.firstObject(), Optional<T>.self) }
    Show on GitHub

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

    Declaration

    Swift

    public var last: T? { return unsafeBitCast(rlmResults.lastObject(), Optional<T>.self) }
    Show on GitHub

KVC

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

    Declaration

    Swift

    public override func valueForKey(key: String) -> AnyObject?

    Parameters

    key

    The name of the property.

    Return Value

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

    Show on GitHub

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

    Declaration

    Swift

    public override func valueForKeyPath(keyPath: String) -> AnyObject?

    Parameters

    keyPath

    The key path to the property.

    Return Value

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

    Show on GitHub

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

    Warning

    This method can only be called during a write transaction.

    Declaration

    Swift

    public override func setValue(value: AnyObject?, forKey key: String)

    Parameters

    value

    The object value.
    key

    The name of the property.
    Show on GitHub

Filtering

  • Filters the results to the objects that match the given predicate.

    Declaration

    Swift

    public func filter(predicateFormat: String, _ args: AnyObject...) -> Results<T>

    Parameters

    predicateFormat

    The predicate format string which can accept variable arguments.

    Return Value

    Results containing objects that match the given predicate.

    Show on GitHub

  • Filters the results to the objects that match the given predicate.

    Declaration

    Swift

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

    Parameters

    predicate

    The predicate to filter the objects.

    Return Value

    Results containing objects that match the given predicate.

    Show on GitHub

Sorting

  • Returns Results with elements sorted by the given property name.

    Declaration

    Swift

    public func sorted(property: String, ascending: Bool = true) -> Results<T>

    Parameters

    property

    The property name to sort by.
    ascending

    The direction to sort by.

    Return Value

    Results with elements sorted by the given property name.

    Show on GitHub

  • Returns Results with elements sorted by the given sort descriptors.

    Declaration

    Swift

    public func sorted<S: SequenceType where S.Generator.Element == SortDescriptor>(sortDescriptors: S) -> Results<T>

    Parameters

    sortDescriptors

    SortDescriptors to sort by.

    Return Value

    Results with elements sorted by the given sort descriptors.

    Show on GitHub

Aggregate Operations

  • Returns the minimum value of the given property.

    Warning

    Only names of properties of a type conforming to the MinMaxType protocol can be used.

    Declaration

    Swift

    public func min<U: MinMaxType>(property: String) -> U?

    Parameters

    property

    The name of a property conforming to MinMaxType to look for a minimum on.

    Return Value

    The minimum value for the property amongst objects in the Results, or nil if the Results is empty.

    Show on GitHub

  • Returns the maximum value of the given property.

    Warning

    Only names of properties of a type conforming to the MinMaxType protocol can be used.

    Declaration

    Swift

    public func max<U: MinMaxType>(property: String) -> U?

    Parameters

    property

    The name of a property conforming to MinMaxType to look for a maximum on.

    Return Value

    The maximum value for the property amongst objects in the Results, or nil if the Results is empty.

    Show on GitHub

  • Returns the sum of the given property for objects in the Results.

    Warning

    Only names of properties of a type conforming to the AddableType protocol can be used.

    Declaration

    Swift

    public func sum<U: AddableType>(property: String) -> U

    Parameters

    property

    The name of a property conforming to AddableType to calculate sum on.

    Return Value

    The sum of the given property over all objects in the Results.

    Show on GitHub

  • Returns the average of the given property for objects in the Results.

    Warning

    Only names of properties of a type conforming to the AddableType protocol can be used.

    Declaration

    Swift

    public func average<U: AddableType>(property: String) -> U?

    Parameters

    property

    The name of a property conforming to AddableType to calculate average on.

    Return Value

    The average of the given property over all objects in the Results, or nil if the Results is empty.

    Show on GitHub

Notifications

  • Register a block to be called each time the Results changes.

    The block will be asynchronously called with the initial results, and then called again after each write transaction which causes the results to change. You must retain the returned token for as long as you want the results to continue to be sent to the block. To stop receiving updates, call stop() on the token.

    The determination for whether or not a write transaction has changed the results is currently very coarse, and the block may be called even if no changes occurred. The opposite (not being called despite changes) will not happen. This will become more precise in future versions.

    If an error occurs the block will be called with nil for the results parameter and a non-nil error. Currently the only errors that can occur are when opening the Realm on the background worker thread or the destination queue fails.

    At the time when the block is called, the Results object 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.

    Warning

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

    Declaration

    Swift

    public func addNotificationBlock(block: (results: Results<T>?, error: NSError?) -> ()) -> NotificationToken

    Parameters

    block

    The block to be called with the evaluated results.

    Return Value

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

    Show on GitHub

Sequence Support

  • Returns a GeneratorOf<T> that yields successive elements in the results.

    Declaration

    Swift

    public func generate() -> RLMGenerator<T>
    Show on GitHub

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 { return 0 }
    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 { return count }
    Show on GitHub