Skip to content

refactor!: prefix AwaitOperationConfiguration cases with Await #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xperiandri wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor!: prefix AwaitOperationConfiguration cases with Await #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Changed

- **Breaking:** `AwaitOperationConfiguration` cases are prefixed with `Await` (`AwaitSequential`, `AwaitParallel 4`, ...) so they no longer collide with `System.Threading.Tasks.Parallel`

## [0.3.1] - 2026-01-28

### Fixed
Expand Down
47 changes: 27 additions & 20 deletions src/FSharp.Control.R3/ProcessingOptions.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,30 @@ open System.Threading
open System.Threading.Tasks
open R3

/// <summary>
/// Defines how an asynchronous selector processes source elements that arrive while a previous invocation is still running.
/// <para>
/// The cases carry the <c>Await</c> prefix so that they never collide with other names opened next to
/// <see cref="N:FSharp.Control.R3"/>, such as <see cref="T:System.Threading.Tasks.Parallel"/>.
/// </para>
/// </summary>
type AwaitOperationConfiguration =
/// <summary>All values are queued, and the next value waits for the completion of the asynchronous method.</summary>
| Sequential
| AwaitSequential
/// <summary>Drop new value when async operation is running.</summary>
| Drop
| AwaitDrop
/// <summary>If the previous asynchronous method is running, it is cancelled and the next asynchronous method is executed.</summary>
| Switch
| AwaitSwitch
/// <summary>All values are sent immediately to the asynchronous method.</summary>
| Parallel of
| AwaitParallel of
/// If set to -1, there is no limit.
MaxConcurrent : int
/// <summary>All values are sent immediately to the asynchronous method, but the results are queued and passed to the next operator in order.</summary>
| SequentialParallel of
| AwaitSequentialParallel of
/// If set to -1, there is no limit.
MaxConcurrent : int
/// <summary>Send the first value and the last value while the asynchronous method is running.</summary>
| ThrottleFirstLast
| AwaitThrottleFirstLast

type ProcessingOptions = {
AwaitOperationConfiguration : AwaitOperationConfiguration
Expand All @@ -30,13 +37,13 @@ type ProcessingOptions = {
} with

static let ``default`` = {
AwaitOperationConfiguration = AwaitOperationConfiguration.Sequential
AwaitOperationConfiguration = AwaitOperationConfiguration.AwaitSequential
ConfigureAwait = true
CancelOnCompleted = false
}

static let ``parallel`` = {
AwaitOperationConfiguration = AwaitOperationConfiguration.Parallel -1
AwaitOperationConfiguration = AwaitOperationConfiguration.AwaitParallel -1
ConfigureAwait = true
CancelOnCompleted = false
}
Expand All @@ -46,21 +53,21 @@ type ProcessingOptions = {

member this.MaxConcurrent =
match this.AwaitOperationConfiguration with
| AwaitOperationConfiguration.Sequential -> -1
| AwaitOperationConfiguration.Drop -> -1
| AwaitOperationConfiguration.Switch -> -1
| AwaitOperationConfiguration.Parallel maxConcurrent -> maxConcurrent
| AwaitOperationConfiguration.SequentialParallel maxConcurrent -> maxConcurrent
| AwaitOperationConfiguration.ThrottleFirstLast -> -1
| AwaitOperationConfiguration.AwaitSequential -> -1
| AwaitOperationConfiguration.AwaitDrop -> -1
| AwaitOperationConfiguration.AwaitSwitch -> -1
| AwaitOperationConfiguration.AwaitParallel maxConcurrent -> maxConcurrent
| AwaitOperationConfiguration.AwaitSequentialParallel maxConcurrent -> maxConcurrent
| AwaitOperationConfiguration.AwaitThrottleFirstLast -> -1

member this.AwaitOperation =
match this.AwaitOperationConfiguration with
| AwaitOperationConfiguration.Sequential -> AwaitOperation.Sequential
| AwaitOperationConfiguration.Drop -> AwaitOperation.Drop
| AwaitOperationConfiguration.Switch -> AwaitOperation.Switch
| AwaitOperationConfiguration.Parallel _ -> AwaitOperation.Parallel
| AwaitOperationConfiguration.SequentialParallel _ -> AwaitOperation.SequentialParallel
| AwaitOperationConfiguration.ThrottleFirstLast -> AwaitOperation.ThrottleFirstLast
| AwaitOperationConfiguration.AwaitSequential -> AwaitOperation.Sequential
| AwaitOperationConfiguration.AwaitDrop -> AwaitOperation.Drop
| AwaitOperationConfiguration.AwaitSwitch -> AwaitOperation.Switch
| AwaitOperationConfiguration.AwaitParallel _ -> AwaitOperation.Parallel
| AwaitOperationConfiguration.AwaitSequentialParallel _ -> AwaitOperation.SequentialParallel
| AwaitOperationConfiguration.AwaitThrottleFirstLast -> AwaitOperation.ThrottleFirstLast

type ChunkConfiguration<'T> =
| ChunkCount of WindowLength : int
Expand Down
Loading