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
    Show on GitHub

  • Returns the Realm these results are associated with.

    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?
    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?
    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?
    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?
    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)
    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>
    Show on GitHub

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

    Declaration

    Swift

    public func filter(predicate: NSPredicate) -> Results<T>
    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>
    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>
    Show on GitHub

Aggregate Operations

  • Returns the minimum value of the given property.

    Declaration

    Swift

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

  • Returns the maximum value of the given property.

    Declaration

    Swift

    public func max<U: MinMaxType>(property: String) -> U?
    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
    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?
    Show on GitHub