Results

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 cannot be created directly.

Properties

  • 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

  • Element type contained in this collection.

    Declaration

    Swift

    public typealias Element = T
    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 given 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 given 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 rlmResults.firstObject() as! T? }
    Show on GitHub

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

    Declaration

    Swift

    public var last: T? { return rlmResults.lastObject() as! T? }
    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

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

    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.

    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.

    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.

    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.

    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