An effect that will cancel any currently in-flight effect with the given identifier.
static func cancel(id: some Hashable & Sendable) -> Effect<Action> s22ComposableArchitecture6EffectV6cancel2idACyxGqd___tSHRd__s8SendableRd__lFZ What are these?326SOAn effect identifier.
A new effect that will cancel any currently in-flight effect with the given identifier.
import ComposableArchitectureThe Composable Architecture (TCA, for short) is a library for building applications in a consistent and understandable way, with composition, testing, and ergonomics in mind. It can be used in SwiftUI, UIKit, and more, and on any Apple platform (iOS, macOS, tvOS, and watchOS).
struct Effect<Action>protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol Sendablefunc cancellable(id: some Hashable & Sendable, cancelInFlight: Bool = false) -> Effect<Action> Turns an effect into one that is capable of being canceled.
func withTaskCancellation<T>(id: some Hashable & Sendable, cancelInFlight: Bool = false, isolation: isolated (any Actor)? = #isolation, operation: @escaping () async throws -> T) async rethrows -> T where T : Sendable Execute an operation with a cancellation identifier.
static func cancel(id: some Hashable & Sendable) Cancel any currently in-flight operation with the given identifier.
static var none: Self { get }An effect that does nothing and completes immediately. Useful for situations where you must return an effect, but you don’t need to do anything.
static func concatenate(_ effects: Self...) -> Effect<Action> Concatenates a variadic list of effects together into a single effect, which runs the effects one after the other.
static func concatenate(_ effects: some Collection<Self>) -> Effect<Action> Concatenates a collection of effects together into a single effect, which runs the effects one after the other.
static func merge(_ effects: Self...) -> Effect<Action> Merges a variadic list of effects together into a single effect, which runs the effects at the same time.
static func merge(_ effects: some Sequence<Self>) -> Effect<Action> Merges a sequence of effects together into a single effect, which runs the effects at the same time.
static func publisher(_ createPublisher: () -> some Publisher<Action, Never>) -> Effect<Action> Creates an effect from a Combine publisher.
static func run(priority: TaskPriority? = nil, operation: @escaping (_ send: Send<Action>) async throws -> Void, catch handler: ((_ error: any Error, _ send: Send<Action>) async -> Void)? = nil, fileID: StaticString = #fileID, filePath: StaticString = #filePath, line: UInt = #line, column: UInt = #column) -> Effect<Action> Wraps an asynchronous unit of work that can emit actions any number of times in an effect.
static func send(_ action: Action) -> Effect<Action> Initializes an effect that immediately emits the action passed in.
static func send(_ action: Action, animation: Animation? = nil) -> Effect<Action> Initializes an effect that immediately emits the action passed in.
func animation(_ animation: Animation? = .default) -> Effect<Action> Wraps the emission of each element with SwiftUI’s withAnimation.
func concatenate(with other: Self) -> Effect<Action> Concatenates this effect and another into a single effect that first runs this effect, and after it completes or is cancelled, runs the other.
func debounce<S>(id: some Hashable & Sendable, for dueTime: S.SchedulerTimeType.Stride, scheduler: S, options: S.SchedulerOptions? = nil) -> Effect<Action> where S : Scheduler Turns an effect into one that can be debounced.
func map<T>(_ transform: @escaping (Action) -> T) -> Effect<T> Transforms all elements from the upstream effect with a provided closure.
func merge(with other: Self) -> Effect<Action> Merges this effect and another into a single effect that runs both at the same time.
func transaction(_ transaction: Transaction) -> Effect<Action> Wraps the emission of each element with SwiftUI’s withTransaction.