SectionedResultsChangeset
@frozen
public struct SectionedResultsChangeset<Collection> : Publisher where Collection : RealmSectionedResult
A publisher which emits SectionedResultsChange
receive(on:)
and subscribe(on:)
can be called directly on this
publisher, and calling .threadSafeReference()
is only required if
there is an intermediate transform. If subscribe(on:)
is used, it
should always be the first operation in the pipeline.
Create this publisher using the changesetPublisher
property on RealmSectionedResult.
-
Declaration
Swift
public typealias Output = SectionedResultsChange<Collection>
-
This publisher reports error via the
.error
case of SectionedResultsChange.Declaration
Swift
public typealias Failure = Never
-
Captures the
NotificationToken
produced by observing the collection.This allows you to do notification skipping when performing a
Realm.write(withoutNotifying:)
. You should use this call if you require to write to the Realm database and ignore this specific observation chain. TheNotificationToken
will be saved on the specifiedKeyPath
from the observation block set up inreceive(subscriber:)
.Declaration
Swift
public func saveToken<T>(on object: T, at keyPath: WritableKeyPath<T, NotificationToken?>) -> SectionedResultsChangesetWithToken<Collection, T>
Parameters
object
The object which the
NotificationToken
is written to.keyPath
The KeyPath which the
NotificationToken
is written to.Return Value
A
SectionedResultsChangesetWithToken
Publisher. -
Specifies the scheduler on which to perform subscribe, cancel, and request operations.
For Realm Publishers, this determines which queue the underlying change notifications are sent to. If
receive(on:)
is not used subsequently, it also will determine which queue elements received from the publisher are evaluated on. Currently only serial dispatch queues are supported, and theoptions:
parameter is not supported.Declaration
Swift
public func subscribe<S>(on scheduler: S) -> SectionedResultsChangeset<Collection> where S : Scheduler
Parameters
scheduler
The serial dispatch queue to perform the subscription on.
Return Value
A publisher which subscribes on the given scheduler.
-
Specifies the scheduler on which to perform downstream operations.
This differs from
subscribe(on:)
in how it is integrated with the autorefresh cycle. When usingsubscribe(on:)
, the subscription is performed on the target scheduler and the publisher will emit the collection during the refresh. When usingreceive(on:)
, the collection is then converted to aThreadSafeReference
and delivered to the target scheduler with no integration into the autorefresh cycle, meaning it may arrive some time after the refresh occurs.When in doubt, you probably want
subscribe(on:)
Declaration
Swift
public func receive<S>(on scheduler: S) -> DeferredHandoverSectionedResultsChangeset<`Self`, Collection, S> where S : Scheduler
Parameters
scheduler
The serial dispatch queue to receive values on.
Return Value
A publisher which delivers values to the given scheduler.