ObservableAsync.FromAsync(Func>) method¶
Defined in
Type: ObservableAsync
Namespace: ReactiveUI.Extensions.Async
Assembly: ReactiveUI.Extensions.dll
Applies to
net10.0, net10.0-browserwasm1.0, net10.0-desktop1.0, net9.0, net9.0-browserwasm1.0, net9.0-desktop1.0, net8.0, net8.0-ios17.5, net8.0-maccatalyst17.5, net8.0-macos14.2, net8.0-macos14.5, net8.0-tvos17.2, netstandard2.1, net462, net481
Overloads¶
- 1.
public static IObservableAsync<T> FromAsync<T>(Func<CancellationToken, ValueTask<T>> factory) - 2.
public static IObservableAsync<Unit> FromAsync(Func<CancellationToken, ValueTask> factory)
1. Overload¶
public static IObservableAsync<T> FromAsync<T>(Func<CancellationToken, ValueTask<T>> factory)
Summary: Creates an asynchronous observable sequence that emits a single value produced by the specified factory function.
Type parameters
| Name | Description |
|---|---|
T | The type of the value produced by the factory and emitted by the observable sequence. |
Parameters
| Name | Type | Description |
|---|---|---|
factory | Func | A function that asynchronously produces a value of type T when invoked with a CancellationToken. Cannot be null. |
Returns: IObservableAsync
Remarks
The observable sequence will emit the value produced by the factory and then signal completion. The factory function is invoked when the sequence is subscribed to, and supports cancellation via the provided CancellationToken.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown if factory is null. |
2. Overload¶
public static IObservableAsync<Unit> FromAsync(Func<CancellationToken, ValueTask> factory)
Summary: Creates an asynchronous observable sequence that executes the specified factory function and signals completion when the operation finishes.
Parameters
| Name | Type | Description |
|---|---|---|
factory | Func | A function that performs the asynchronous operation. The function receives a cancellation token that can be used to cancel the operation. |
Returns: IObservableAsync
Remarks
The returned observable executes the factory function as a background job. The sequence emits Default after the factory completes and then signals completion. Cancellation is supported via the provided token.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown if factory is null. |