结果

@frozen
public struct Results<Element> : Equatable where Element : RealmCollectionValue
extension Results: RealmSubscribable
extension Results: RealmCollection
extension Results: Encodable where Element: Encodable

Results 是 Realm 中从对象查询返回的自动更新container类型。

Results 可以使用与List<Element>相同的谓词进行查询,并且可以链式查询以进一步筛选查询结果。

Results 始终反映当前线程上的 Realm 的当前状态,包括在当前线程上的写事务(write transaction)期间。唯一的例外是使用for...in枚举时,该枚举将始终枚举开始枚举时与查询匹配的对象,即使其中一些对象在枚举期间被删除或修改为被筛选器排除。

Results 首次访问时延迟求值;它们仅在请求查询结果时才运行查询。 这意味着链接多个临时Results来对数据进行排序和筛选不会执行任何不必要的中间状态处理工作。

评估结果或添加通知块后,系统会立即使结果保持最新,并尽可能在背景线程上完成保持最新的工作。

结果实例无法直接实例化。

属性

  • 管理此结果的Realm 。 请注意,此属性永远不会返回nil

    声明

    Swift

    public var realm: Realm? { get }
  • 指示结果是否不再有效。

    如果对包含的realm调用invalidate() ,结果将无效。 可以访问无效的结果,但始终为空。

    声明

    Swift

    public var isInvalidated: Bool { get }
  • 结果中的对象数量。

    声明

    Swift

    public var count: Int { get }

索引检索

  • 返回给定对象在结果中的索引,如果该对象不存在,则返回nil

    声明

    Swift

    public func index(of object: Element) -> Int?
  • 返回与谓词匹配的第一个对象的索引,如果没有对象匹配,则返回nil

    声明

    Swift

    public func index(matching predicate: NSPredicate) -> Int?

    参数

    predicate

    用于筛选对象的谓词。

对象检索

  • 返回给定index处的对象。

    声明

    Swift

    public subscript(position: Int) -> Element { get }

    参数

    index

    索引。

  • 返回结果中的第一个对象,如果结果为空,则返回nil

    声明

    Swift

    public var first: Element? { get }
  • 返回结果中的最后一个对象,如果结果为空,则返回nil

    声明

    Swift

    public var last: Element? { get }

KVC

  • 返回一个Array ,其中包含调用valueForKey(_:)的结果,并对每个结果使用key

    声明

    Swift

    public func value(forKey key: String) -> Any?

    参数

    key

    所需值的属性的名称。

  • 返回一个Array ,其中包含调用valueForKeyPath(_:)的结果,并对每个结果使用keyPath

    声明

    Swift

    public func value(forKeyPath keyPath: String) -> Any?

    参数

    keyPath

    所需值属性的键路径。

  • setValue(_:forKey:)使用指定的value 和 在结果表示的每个对象上调用key

    警告

    此方法只能在写事务(write transaction)期间调用。

    声明

    Swift

    public func setValue(_ value: Any?, forKey key: String)

    参数

    value

    对象值。

    key

    应在每个对象上设置其值的属性的名称。

过滤

  • 返回一个Results ,其中包含collection中与给定谓词匹配的所有对象。

    声明

    Swift

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

    参数

    predicate

    用于筛选对象的谓词。

排序

  • 返回一个Results ,其中包含结果表示的对象,但已排序。

    对象根据给定键路径的值进行排序。 例如,要根据Student age属性对collection从新到旧进行排序,您可以调用students.sorted(byKeyPath: "age", ascending: true)

    警告

    collection只能按boolean、 DateNSDate 、单精度和双精度浮点、整数和字符串类型的属性进行排序。

    声明

    Swift

    public func sorted(byKeyPath keyPath: String, ascending: Bool = true) -> Results<Element>

    参数

    keyPath

    排序依据的键路径。

    ascending

    排序的方向。

  • 返回一个Results ,其中包含结果表示的对象,但已排序。

    警告

    collection只能按boolean、 DateNSDate 、单精度和双精度浮点、整数和字符串类型的属性进行排序。

    声明

    Swift

    public func sorted<S: Sequence>(by sortDescriptors: S) -> Results<Element>
        where S.Iterator.Element == SortDescriptor

    参数

    sortDescriptors

    作为排序依据的SortDescriptor序列。

  • 根据指定的键路径返回包含不同对象的Results

    声明

    Swift

    public func distinct<S: Sequence>(by keyPaths: S) -> Results<Element>
        where S.Iterator.Element == String

    参数

    keyPaths

    使用的键路径会产生不同的结果

聚合操作

  • 返回所有结果中给定属性的最小值,如果结果为空,则返回nil

    警告

    只能指定类型符合MinMaxType协议的属性。

    声明

    Swift

    public func min<T>(ofProperty property: String) -> T? where T : MinMaxType

    参数

    property

    所需最小值的属性名称。

  • 返回所有结果中给定属性的最大值,如果结果为空,则返回nil

    警告

    只能指定类型符合MinMaxType协议的属性。

    声明

    Swift

    public func max<T>(ofProperty property: String) -> T? where T : MinMaxType

    参数

    property

    所需最小值的属性名称。

  • 返回所有结果中给定属性值的总和。

    警告

    只能指定类型符合AddableType协议的属性。

    声明

    Swift

    public func sum<T>(ofProperty property: String) -> T where T : AddableType

    参数

    property

    应对其值求和的属性的名称。

  • 返回所有结果中给定属性的平均值,如果结果为空,则返回nil

    警告

    只能指定类型符合AddableType协议的属性的名称。

    声明

    Swift

    public func average<T>(ofProperty property: String) -> T? where T : AddableType

    参数

    property

    应计算其平均值的属性的名称。

通知

  • 注册一个区块,以便在每次collection更改时调用。

    该区块将与初始结果一起异步调用,然后在每次写事务(write transaction)后再次调用,这会更改collection中的任何对象或collection中的哪些对象。

    传递给区块的change参数以collection内索引的形式报告在每个写事务(write transaction)期间添加、删除或修改了哪些对象。有关所提供变更信息的更多信息,以及如何使用这些信息来更新UITableView的示例,请参阅RealmCollectionChange文档。

    调用区块时,collection将进行全面求值且是最新的,只要不在同一线程上执行写事务(write transaction)或显式调用realm.refresh() ,访问该collection就永远不会执行阻塞工作。

    如果未指定队列,则将通过标准事件循环传递通知,因此当事件循环被其他活动阻塞时无法传递通知。如果给出了队列,则将通知传递到该队列。 当无法立即传递通知时,可以将多个通知合并为一个通知。 这可以包括初始collection的通知。

    例如,以下代码在添加通知块后立即执行写事务(write transaction),因此没有机会首先传递初始通知。因此,初始通知将反映写事务后 Realm 的状态。

    let dogs = realm.objects(Dog.self)
    print("dogs.count: \(dogs?.count)") // => 0
    let token = dogs.observe { changes 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
    

    只要您希望将更新发送到区块,就必须保留返回的令牌。 要停止接收更新,请对令牌调用invalidate()

    警告

    在写事务(write transaction)期间或当包含的 Realm 为只读时,无法调用此方法。

    声明

    Swift

    public func observe(on queue: DispatchQueue? = nil,
                        _ block: @escaping (RealmCollectionChange<Results>) -> Void) -> NotificationToken

    参数

    queue

    用于接收通知的串行调度队列。 如果为nil ,则通知将传递到当前线程。

    block

    发生更改时要调用的区块。

    返回值

    只要您希望传递更新,就必须持有的令牌。

冻结对象

结果

  • 每次collection更改时发出 Void 的发布者。

    尽管有这个名称,但它实际上是在collection发生更改发出的。

    声明

    Swift

    public var objectWillChange: RealmPublishers.WillChange<Results> { get }

序列支持

集合支持

适用于以下位置: ElementEncodable