No overview available.
SDKs
- iOS 13.0+
- macOS 10.15+
- Mac Catalyst 13.0+
- tvOS 13.0+
- watchOS 6.0+
- Xcode 11.0+
Framework
- Combine
Generic StructurePublishers
Publishers
Topics
Instance Methods
func allPublishes a single Boolean value that indicates whether all received elements pass a given predicate.
func append(UpstreamAppend a Publisher’s output with the specified sequence.
func assertRaises a fatal error when its upstream publisher fails, and otherwise republishes all received input.
func assign<Root>(to: ReferenceAssigns the value of a KVO-compliant property from a publisher.
func breakpoint(receiveRaises a debugger signal when a provided closure needs to stop the process in the debugger.
func breakpointRaises a debugger signal upon receiving a failure.
func `catch`<P>((UpstreamHandles errors from an upstream publisher by replacing it with another publisher.
func collect() -> PublishersCollects all received elements, and emits a single array of the collection when the upstream publisher finishes.
func collect(Int) -> PublishersCollects up to the specified number of elements, and then emits a single array of the collection.
func collect<S>(PublishersCollects elements by a given strategy, and emits a single array of the collection.
func compactCalls a closure with each received element and publishes any returned optional that has a value.
func contains(UpstreamPublishes a Boolean value upon receiving an element equal to the argument.
func contains(where: (UpstreamPublishes a Boolean value upon receiving an element that satisfies the predicate closure.
func count() -> PublishersPublishes the number of elements received from the upstream publisher.
func debounce<S>(for: SPublishes elements only after a specified time interval elapses between events.
func decode<Item, Coder>(type: ItemDecodes the output from upstream using a specified Top. For example, use JSONDecoder.
func delay<S>(for: SDelays delivery of all output to the downstream receiver by a specified amount of time on a particular scheduler.
func drop<P>(untilIgnores elements from the upstream publisher until it receives an element from a second publisher.
func drop(while: (UpstreamOmits elements from the upstream publisher until a given closure returns false, before republishing all remaining elements.
func dropOmits the specified number of elements before republishing subsequent elements.
func encode<Coder>(encoder: Coder) -> PublishersEncodes the output from upstream using a specified Top. For example, use JSONEncoder.
func filter((UpstreamRepublishes all elements that match a provided closure.
func first() -> PublishersPublishes the first element of a stream, then finishes.
func first(where: (UpstreamPublishes the first element of a stream to satisfy a predicate closure, then finishes.
func flatTransforms all elements from an upstream publisher into a new or existing publisher.
func handlePerforms the specified closures when publisher events occur.
func ignoreIngores all upstream elements, but passes along a completion state (finished or failed).
func last() -> PublishersOnly publishes the last element of a stream, after the stream finishes.
func last(where: (UpstreamOnly publishes the last element of a stream that satisfies a predicate closure, after the stream finishes.
func makeCreates a connectable wrapper around the publisher.
func map<T>((UpstreamTransforms all elements from the upstream publisher with a provided closure.
func mapConverts any failure from the upstream publisher into a new error.
func max() -> PublishersPublishes the maximum value received from the upstream publisher, after it finishes.
func max(by: (UpstreamPublishes the maximum value received from the upstream publisher, using the provided ordering closure.
func measureMeasures and emits the time interval between events received from an upstream publisher.
func merge(with: PublishersCombines elements from this publisher with those from another publisher of the same type, delivering an interleaved sequence of elements.
func merge<B, C>(with: B, C) -> PublishersCombines elements from this publisher with those from two other publishers, delivering an interleaved sequence of elements.
func merge<B, C, D>(with: B, C, D) -> PublishersCombines elements from this publisher with those from three other publishers, delivering an interleaved sequence of elements.
func merge<B, C, D, E>(with: B, C, D, E) -> PublishersCombines elements from this publisher with those from four other publishers, delivering an interleaved sequence of elements.
func merge<B, C, D, E, F>(with: B, C, D, E, F) -> PublishersCombines elements from this publisher with those from five other publishers, delivering an interleaved sequence of elements.
func merge<B, C, D, E, F, G>(with: B, C, D, E, F, G) -> PublishersCombines elements from this publisher with those from six other publishers, delivering an interleaved sequence of elements.
func merge<B, C, D, E, F, G, H>(with: B, C, D, E, F, G, H) -> PublishersCombines elements from this publisher with those from seven other publishers, delivering an interleaved sequence of elements.
func min() -> PublishersPublishes the minimum value received from the upstream publisher, after it finishes.
func min(by: (UpstreamPublishes the minimum value received from the upstream publisher, after it finishes.
func output(at: Int) -> PublishersPublishes a specific element, indicated by its index in the sequence of published elements.
func output<R>(in: R) -> PublishersPublishes elements specified by their range in the sequence of published elements.
func prefix(Int) -> PublishersRepublishes elements up to the specified maximum count.
func prefix<P>(untilRepublishes elements until another publisher emits an element.
func prefix(while: (UpstreamRepublishes elements while a predicate closure indicates publishing should continue.
func prepend(UpstreamPrefixes a Publisher’s output with the specified sequence.
func print(String, to: TextPrints log messages for all publishing events.
func receive<S>(on: S, options: SSpecifies the scheduler on which to receive elements from the publisher.
func reduce<T>(T, (T, UpstreamApplies a closure that accumulates each element of a stream and publishes a final result upon completion.
func removePublishes only elements that don’t match the previous element.
func replaceReplaces an empty stream with the provided element.
func replaceReplaces any errors in the stream with the provided element.
func replaceReplaces nil elements in the stream with the proviced element.
func retry(Int) -> PublishersAttempts to recreate a failed subscription with the upstream publisher using a specified number of attempts to establish the connection.
func scan<T>(T, (T, UpstreamTransforms elements from the upstream publisher by providing the current element to a closure along with the last value returned by the closure.
func setChanges the failure type declared by the upstream publisher.
func share() -> PublishersReturns a publisher as a class instance.
func subscribe<S>(S) -> AnyAttaches the specified Subscriber to this Publisher.
func subscribe<S>(S)Attaches the specified subscriber to this publisher.
func subscribe<S>(on: S, options: SSpecifies the scheduler on which to perform subscribe, cancel, and request operations.
func switchFlattens the stream of events from multiple upstream publishers to appear as if they were coming from a single stream of events.
func throttle<S>(for: SPublishes either the most-recent or first element published by the upstream publisher in the specified time interval.
func timeout<S>(STerminates publishing if the upstream publisher exceeds the specified time interval without producing an element.
func tryPublishes a single Boolean value that indicates whether all received elements pass a given error-throwing predicate.
func tryCalls an error-throwing closure with each received element and publishes any returned optional that has a value.
func tryPublishes a Boolean value upon receiving an element that satisfies the throwing predicate closure.
func tryOmits elements from the upstream publisher until an error-throwing closure returns false, before republishing all remaining elements.
func tryRepublishes all elements that match a provided error-throwing closure.
func tryPublishes the first element of a stream to satisfy a throwing predicate closure, then finishes.
func tryOnly publishes the last element of a stream that satisfies a error-throwing predicate closure, after the stream finishes.
func tryTransforms all elements from the upstream publisher with a provided error-throwing closure.
func tryPublishes the maximum value received from the upstream publisher, using the provided error-throwing closure to order the items.
func tryPublishes the minimum value received from the upstream publisher, using the provided error-throwing closure to order the items.
func tryRepublishes elements while a error-throwing predicate closure indicates publishing should continue.
func tryApplies an error-throwing closure that accumulates each element of a stream and publishes a final result upon completion.
func tryTransforms elements from the upstream publisher by providing the current element to an error-throwing closure along with the last value returned by the closure.
func zip<P>(P) -> PublishersCombine elements from another publisher and deliver pairs of elements as tuples.
func zip<P, Q>(P, Q) -> PublishersCombine elements from two other publishers and deliver groups of elements as tuples.
func zip<P, Q, R>(P, Q, R) -> PublishersCombine elements from three other publishers and deliver groups of elements as tuples.
Relationships
Conforms To
See Also
Controlling Timing
struct PublishersA publisher that publishes elements only after a specified time interval elapses between events.
struct PublishersA publisher that delays delivery of elements and completion to the downstream receiver.
struct PublishersA publisher that measures and emits the time interval between events received from an upstream publisher.
struct PublishersA publisher that publishes either the most-recent or first element published by the upstream publisher in a specified time interval.