ResultsSection

public struct ResultsSection<Key, T> : RealmSectionedResultImpl where Key : _Persistable, Key : Hashable, T : RealmCollectionValue
extension ResultsSection: RealmSubscribable
extension ResultsSection: Identifiable

ResultsSection is a collection which allows access to objects that belong to a given section key. The collection is lazily evaluated, meaning that if the underlying collection has changed a full recalculation of the section keys will take place. A ResultsSection instance can be observed and it also conforms to ThreadConfined.

  • Declaration

    Swift

    public typealias Element = T
  • The total number of objects in this section.

    Declaration

    Swift

    public var count: Int { get }
  • key

    The key which represents this section.

    Declaration

    Swift

    public var key: Key { get }
  • Returns the object at the given index.

    Declaration

    Swift

    public subscript(index: Int) -> T { get }

    Parameters

    index

    The index.

  • Registers a block to be called each time the sectioned results collection changes.

    The block will be asynchronously called with the initial sectioned results collection, and then called again after each write transaction which changes either any of the objects in the sectioned results collection, or which objects are in the sectioned results collection.

    The change parameter that is passed to the block reports, in the form of indices within the collection, which of the objects were added, removed, or modified during each write transaction. See the RealmSectionedResultsChange documentation for more information on the change information supplied and an example of how to use it to update a UITableView.

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

    If no queue is given, notifications are delivered via the standard run loop, and so can’t be delivered while the run loop is blocked by other activity. If a queue is given, notifications are delivered to that queue instead. When notifications can’t be delivered instantly, multiple notifications may be coalesced into a single notification. This can include the notification with the initial sectioned results collection.

    For example, the following code performs a write transaction immediately after adding the notification block, so there is no opportunity for the initial notification to be delivered first. As a result, the initial notification will reflect the state of the Realm after the write transaction.

    let dogs = realm.objects(Dog.self)
    let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
    print("sectionedResults.count: \(sectionedResults?.count)") // => 0
    let token = sectionedResults.observe { changes in
        switch changes {
        case .initial(let sectionedResults):
            // Will print "sectionedResults.count: 1"
            print("sectionedResults.count: \(sectionedResults.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
    

    If no key paths are given, the block will be executed on any insertion, modification, or deletion for all object properties and the properties of any nested, linked objects. If a key path or key paths are provided, then the block will be called for changes which occur only on the provided key paths. For example, if:

    class Dog: Object {
        @Persisted var name: String
        @Persisted var age: Int
        @Persisted var toys: List<Toy>
    }
    // ...
    let dogs = realm.objects(Dog.self)
    let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
    let token = sectionedResults.observe(keyPaths: ["name"]) { changes in
        switch changes {
        case .initial(let sectionedResults):
           // ...
        case .update:
           // This case is hit:
           // - after the token is initialized
           // - when the name property of an object in the
           // collection is modified
           // - when an element is inserted or removed
           //   from the collection.
           // This block is not triggered:
           // - when a value other than name is modified on
           //   one of the elements.
        case .error:
            // ...
        }
    }
    // end of run loop execution context
    
    • If the observed key path were ["toys.brand"], then any insertion or deletion to the toys list on any of the collection’s elements would trigger the block. Changes to the brand value on any Toy that is linked to a Dog in this collection will trigger the block. Changes to a value other than brand on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would also trigger a notification.
    • If the above example observed the ["toys"] key path, then any insertion, deletion, or modification to the toys list for any element in the collection would trigger the block. Changes to any value on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would still trigger a notification.
    • Any modification to the section key path property which results in the object changing position in the section, or changing section entirely will trigger a notification.

    Note

    Multiple notification tokens on the same object which filter for separate key paths do not filter exclusively. If one key path change is satisfied for one notification token, then all notification token blocks for that object will execute.

    You must retain the returned token for as long as you want updates to be sent to the block. To stop receiving updates, call invalidate() on the token.

    Warning

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

    Declaration

    Swift

    public func observe(keyPaths: [String]? = nil,
                        on queue: DispatchQueue? = nil,
                        _ block: @escaping (RealmSectionedResultsChange<Self>) -> Void) -> NotificationToken

    Parameters

    keyPaths

    Only properties contained in the key paths array will trigger the block when they are modified. If nil, notifications will be delivered for any property change on the object. String key paths which do not correspond to a valid a property will throw an exception. See description above for more detail on linked properties.

    queue

    The serial dispatch queue to receive notification on. If nil, notifications are delivered to the current thread.

    block

    The block to be called whenever a change occurs.

    Return Value

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

  • Registers a block to be called each time the sectioned results collection changes.

    The block will be asynchronously called with the initial sectioned results collection, and then called again after each write transaction which changes either any of the objects in the sectioned results collection, or which objects are in the sectioned results collection.

    The change parameter that is passed to the block reports, in the form of indices within the collection, which of the objects were added, removed, or modified during each write transaction. See the RealmSectionedResultsChange documentation for more information on the change information supplied and an example of how to use it to update a UITableView.

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

    If no queue is given, notifications are delivered via the standard run loop, and so can’t be delivered while the run loop is blocked by other activity. If a queue is given, notifications are delivered to that queue instead. When notifications can’t be delivered instantly, multiple notifications may be coalesced into a single notification. This can include the notification with the initial sectioned results collection.

    For example, the following code performs a write transaction immediately after adding the notification block, so there is no opportunity for the initial notification to be delivered first. As a result, the initial notification will reflect the state of the Realm after the write transaction.

    let dogs = realm.objects(Dog.self)
    let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
    print("sectionedResults.count: \(sectionedResults?.count)") // => 0
    let token = sectionedResults.observe { changes in
        switch changes {
        case .initial(let sectionedResults):
            // Will print "sectionedResults.count: 1"
            print("sectionedResults.count: \(sectionedResults.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
    

    If no key paths are given, the block will be executed on any insertion, modification, or deletion for all object properties and the properties of any nested, linked objects. If a key path or key paths are provided, then the block will be called for changes which occur only on the provided key paths. For example, if:

    class Dog: Object {
        @Persisted var name: String
        @Persisted var age: Int
        @Persisted var toys: List<Toy>
    }
    // ...
    let dogs = realm.objects(Dog.self)
    let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
    let token = sectionedResults.observe(keyPaths: ["name"]) { changes in
        switch changes {
        case .initial(let sectionedResults):
           // ...
        case .update:
           // This case is hit:
           // - after the token is initialized
           // - when the name property of an object in the
           // collection is modified
           // - when an element is inserted or removed
           //   from the collection.
           // This block is not triggered:
           // - when a value other than name is modified on
           //   one of the elements.
        case .error:
            // ...
        }
    }
    // end of run loop execution context
    
    • If the observed key path were ["toys.brand"], then any insertion or deletion to the toys list on any of the collection’s elements would trigger the block. Changes to the brand value on any Toy that is linked to a Dog in this collection will trigger the block. Changes to a value other than brand on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would also trigger a notification.
    • If the above example observed the ["toys"] key path, then any insertion, deletion, or modification to the toys list for any element in the collection would trigger the block. Changes to any value on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would still trigger a notification.
    • Any modification to the section key path property which results in the object changing position in the section, or changing section entirely will trigger a notification.

    Note

    Multiple notification tokens on the same object which filter for separate key paths do not filter exclusively. If one key path change is satisfied for one notification token, then all notification token blocks for that object will execute.

    You must retain the returned token for as long as you want updates to be sent to the block. To stop receiving updates, call invalidate() on the token.

    Warning

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

    Declaration

    Swift

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

    Parameters

    queue

    The serial dispatch queue to receive notification on. If nil, notifications are delivered to the current thread.

    block

    The block to be called whenever a change occurs.

    Return Value

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

Sectioned Results

  • A publisher that emits Void each time the results section collection changes.

    Despite the name, this actually emits after the results section collection has changed.

    Declaration

    Swift

    public var objectWillChange: RealmPublishers.WillChange<ResultsSection> { get }
  • A publisher that emits the results section collection each time the results section collection changes.

    Declaration

    Swift

    public var collectionPublisher: RealmPublishers.Value<`Self`> { get }
  • A publisher that emits the results section collection each time the results section collection changes on the given property keyPaths.

    Declaration

    Swift

    public func collectionPublisher(keyPaths: [String]?) -> RealmPublishers.Value<`Self`>
  • A publisher that emits a results section collection changeset each time the results section collection changes.

    Declaration

    Swift

    public var changesetPublisher: RealmPublishers.SectionChangeset<`Self`> { get }
  • A publisher that emits a results section collection changeset each time the results section collection changes on the given property keyPaths.

    Declaration

    Swift

    public func changesetPublisher(keyPaths: [String]?) -> RealmPublishers.SectionChangeset<`Self`>

Available where T: RLMObjectBase

  • Registers a block to be called each time the sectioned results collection changes.

    The block will be asynchronously called with the initial sectioned results collection, and then called again after each write transaction which changes either any of the objects in the sectioned results collection, or which objects are in the sectioned results collection.

    The change parameter that is passed to the block reports, in the form of indices within the collection, which of the objects were added, removed, or modified during each write transaction. See the RealmSectionedResultsChange documentation for more information on the change information supplied and an example of how to use it to update a UITableView.

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

    If no queue is given, notifications are delivered via the standard run loop, and so can’t be delivered while the run loop is blocked by other activity. If a queue is given, notifications are delivered to that queue instead. When notifications can’t be delivered instantly, multiple notifications may be coalesced into a single notification. This can include the notification with the initial sectioned results collection.

    For example, the following code performs a write transaction immediately after adding the notification block, so there is no opportunity for the initial notification to be delivered first. As a result, the initial notification will reflect the state of the Realm after the write transaction.

    let dogs = realm.objects(Dog.self)
    let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
    print("sectionedResults.count: \(sectionedResults?.count)") // => 0
    let token = sectionedResults.observe { changes in
        switch changes {
        case .initial(let sectionedResults):
            // Will print "sectionedResults.count: 1"
            print("sectionedResults.count: \(sectionedResults.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
    

    If no key paths are given, the block will be executed on any insertion, modification, or deletion for all object properties and the properties of any nested, linked objects. If a key path or key paths are provided, then the block will be called for changes which occur only on the provided key paths. For example, if:

    class Dog: Object {
        @Persisted var name: String
        @Persisted var age: Int
        @Persisted var toys: List<Toy>
    }
    // ...
    let dogs = realm.objects(Dog.self)
    let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
    let token = sectionedResults.observe(keyPaths: ["name"]) { changes in
        switch changes {
        case .initial(let sectionedResults):
           // ...
        case .update:
           // This case is hit:
           // - after the token is initialized
           // - when the name property of an object in the
           // collection is modified
           // - when an element is inserted or removed
           //   from the collection.
           // This block is not triggered:
           // - when a value other than name is modified on
           //   one of the elements.
        case .error:
            // ...
        }
    }
    // end of run loop execution context
    
    • If the observed key path were ["toys.brand"], then any insertion or deletion to the toys list on any of the collection’s elements would trigger the block. Changes to the brand value on any Toy that is linked to a Dog in this collection will trigger the block. Changes to a value other than brand on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would also trigger a notification.
    • If the above example observed the ["toys"] key path, then any insertion, deletion, or modification to the toys list for any element in the collection would trigger the block. Changes to any value on any Toy that is linked to a Dog in this collection would not trigger the block. Any insertion or removal to the Dog type collection being observed would still trigger a notification.
    • Any modification to the section key path property which results in the object changing position in the section, or changing section entirely will trigger a notification.

    Note

    Multiple notification tokens on the same object which filter for separate key paths do not filter exclusively. If one key path change is satisfied for one notification token, then all notification token blocks for that object will execute.

    You must retain the returned token for as long as you want updates to be sent to the block. To stop receiving updates, call invalidate() on the token.

    Warning

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

    Declaration

    Swift

    public func observe(keyPaths: [PartialKeyPath<Element>],
                        on queue: DispatchQueue? = nil,
                        _ block: @escaping (RealmSectionedResultsChange<Self>) -> Void) -> NotificationToken

    Parameters

    keyPaths

    Only properties contained in the key paths array will trigger the block when they are modified. If nil, notifications will be delivered for any property change on the object.

    queue

    The serial dispatch queue to receive notification on. If nil, notifications are delivered to the current thread.

    block

    The block to be called whenever a change occurs.

    Return Value

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