結果

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

Results は、オブジェクト クエリから返される Realm の自動更新コンテナ タイプです。

ResultsList<Element>と同じ述語でクエリできます。また、クエリを連鎖させてクエリ結果をさらにフィルタリングできます。

Results は、現在のスレッドでの書込みトランザクション中など、現在のスレッド上の Realm の現在の状態を常に反映します。 これに対する 1 つの例外は、 for...in列挙を使用する場合です。この列では、列挙が開始されると、列挙中にフィルターによって除外されるようにオブジェクトが削除または変更された場合でも、クエリに一致したオブジェクトが常に列挙されます。

Results は、最初にアクセスされたときに遅延評価されるため、クエリの結果が要求された場合にのみクエリを実行します。 つまり、データのソートやフィルタリングのために一時的なResultsを複数連鎖させても、中間状態を処理する不要な作業は実行されません。

結果が評価されるか、通知ブロックが追加されると、結果は早期に最新状態に維持され、可能な場合は常にバックグラウンド スレッドで最新の状態を維持するための作業が実行されます。

結果インスタンスは、直接インスタンス化することはできません。

  • 結果によって表されるオブジェクトの、人間が判読可能な説明。

    宣言

    Swift

    public var description: String { get }
  • 結果によって記述されるオブジェクトの型。

    宣言

    Swift

    public typealias ElementType = Element

プロパティ

  • この結果を管理する Realm 。 このプロパティはnilを返さないことに注意してください。

    宣言

    Swift

    public var realm: Realm? { get }
  • 結果が有効でなくなっているかどうかを示します。

    realmを含む でinvalidate()が呼び出されると、結果は無効になります。 無効化された結果にはアクセスできますが、常に空になります。

    宣言

    Swift

    public var isInvalidated: Bool { get }
  • 結果内のオブジェクトの数。

    宣言

    Swift

    public var count: Int { get }

Index Retrieval

  • 結果内の指定されたオブジェクトのインデックスを返します。オブジェクトが存在しない場合は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 }

KVM

  • 各結果に対してkeyを使用してvalueForKey(_:)を呼び出した結果を含むArrayを返します。

    宣言

    Swift

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

    パラメーター

    key

    値が必要なプロパティの名前。

  • 各結果に対してkeyPathを使用してvalueForKeyPath(_:)を呼び出した結果を含むArrayを返します。

    宣言

    Swift

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

    パラメーター

    keyPath

    値が必要なプロパティへのキー パス。

  • 指定されたvaluekeyを使用して、結果で表される各オブジェクトに対してsetValue(_:forKey:)を呼び出します。

    警告

    このメソッドは、書込みトランザクション中にのみ呼び出されます。

    宣言

    Swift

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

    パラメーター

    value

    オブジェクト値。

    key

    各オブジェクトに値を設定するプロパティの名前。

フィルタリング

  • コレクション内の指定された述語に一致するすべてのオブジェクトを含むResultsを返します。

    宣言

    Swift

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

    パラメーター

    predicate

    オブジェクトをフィルタリングする述語。

ソート

  • 結果で表されるオブジェクトを含むがソートされているResultsを返します。

    オブジェクトは、指定されたキー パスの値に基づいてソートされます。 たとえば、 Studentのコレクションをageプロパティに基づいて、小さいものから古い順に並べ替えるには、 students.sorted(byKeyPath: "age", ascending: true)を呼び出します。

    警告

    コレクションは、ブール値、DateNSDate、単一および倍精度浮動小数点、整数、およびstring型のプロパティでのみソートできます。

    宣言

    Swift

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

    パラメーター

    keyPath

    ソートするキー パス。

    ascending

    並べ替える方向。

  • 結果で表されるオブジェクトを含むがソートされているResultsを返します。

    警告

    コレクションは、ブール値、DateNSDate、単一および倍精度浮動小数点、整数、およびstring型のプロパティでのみソートできます。

    詳細は、次を参照してください:

    sorted(byKeyPath:ascending:)

    宣言

    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

    平均値を計算するプロパティの名前。

notifications

  • コレクションが変更されるたびに呼び出されるブロックを登録します。

    ブロックは初期結果とは非同期に呼び出され、コレクション内のいずれかのオブジェクトまたはコレクション内のどのオブジェクトのいずれかを変更する書込みトランザクションごとに再度呼び出されます。

    ブロックに渡されるchangeパラメータは、各書込みトランザクション中に追加、削除、または変更されたオブジェクトをコレクション内のインデックスの形式で報告します。 提供される変更情報の詳細と、その変更情報を使用してUITableViewをアップデートする方法の例については、 RealmCollectionChangeのドキュメントを参照してください。

    ブロックが呼び出される時点で、コレクションは完全に評価され、最新の状態になります。また、同じスレッドで書込みトランザクションを実行したり、 realm.refresh()を明示的に呼び出したりしない限り、アクセスに関するブロッキングは実行されません動作する。

    キューが指定されていない場合、通知は標準の実行ループを介して配信されるため、実行ループが他のアクティビティによってブロックされている間は通知を配信できません。 キューが指定されている場合、代わりにそのキューに通知が配信されます。 通知をすぐに配信できない場合は、複数の通知が 1 つの通知に統合されることがあります。 これには、初期コレクションの通知を含めることができます。

    たとえば、次のコードは通知ブロックを追加した後すぐに書込みトランザクションを実行するため、最初の通知が最初に配信される可能性はありません。 その結果、最初の通知には、書込みトランザクション後の 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()を呼び出します。

    警告

    このメソッドは、書込みトランザクション中、または Realm を含む が読み取り専用の場合に呼び出すことができません。

    宣言

    Swift

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

    パラメーター

    queue

    通知を受信するシリアル ディスパッチ キュー。 nilの場合、通知は現在のスレッドに配信されます。

    block

    変更が発生するたびに呼び出されるブロック。

    戻り値

    更新を配信する限り保持する必要があるトークン。

凍結されたオブジェクト

結果

  • コレクションが変更されるたびに Vid を発行する出版社。

    名前に関係なく、コレクションが変更されたにこれが実際に発行します。

    宣言

    Swift

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

シーケンス サポート

コレクション サポート

  • 空でないコレクション内の最初の要素の位置。 空のコレクション内の endIndex と同じ。

    宣言

    Swift

    public var startIndex: Int { get }
  • コレクションの「終了を過ぎた」位置。 endIndex はサブスクリプトへの有効な引数ではなく、成功します()の 0 個以上のアプリケーションによって startIndex から常にアクセス可能です。

    宣言

    Swift

    public var endIndex: Int { get }
  • 宣言

    Swift

    public func index(after i: Int) -> Int
  • 宣言

    Swift

    public func index(before i: Int) -> Int

Element : Encodableで利用可能