-
-
Notifications
You must be signed in to change notification settings - Fork 250
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.
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
Add documentation for select
#747
Merged
straight-shoota
merged 4 commits into
crystal-lang:release/1.11
from
straight-shoota:feat/select
Mar 22, 2024
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# select | ||
|
||
The `select` expression chooses from a set of blocking operations and proceeds with the branch that becomes available first. | ||
|
||
## Syntax | ||
|
||
The expression starts with the keyword `select`, followed by a list of one or more `when` branches. | ||
Each branch has a condition and a body, separated by either | ||
a statement separator or the keyword `then`. | ||
Optionally, the last branch may be `else` (without condition). This denotes the `select` action as non-blocking. | ||
The expression closes with an `end` keyword. | ||
|
||
> NOTE: | ||
> `select` is similar to a [`case` expression](./case.md) with all branches referring to potentially blocking operations. | ||
|
||
Each condition is either a call to a select action or an assignment whose right-hand side is a call to a select action. | ||
|
||
```crystal | ||
select | ||
straight-shoota marked this conversation as resolved.
Show resolved
Hide resolved
|
||
when foo = foo_channel.receive | ||
puts foo | ||
when bar = bar_channel.receive? | ||
puts bar | ||
when baz_channel.send | ||
exit | ||
when timeout(5.seconds) | ||
puts "Timeout" | ||
end | ||
``` | ||
|
||
## Select actions | ||
|
||
A select action call calls a method with the implicit suffix `_select_action`, | ||
or `_select_action?` for a call with `?` suffix. | ||
This method returns an instance of the select action. | ||
|
||
The `select` expression initiates the select action associated with each branch. If either of them immediately returns, it proceeds with that. | ||
Otherwise it waits for completion. As soon as one branch completes, all | ||
others are canceled. | ||
An `else` branch completes immediately so there will not be any waiting. | ||
|
||
Execution continues in the completed branch. | ||
If the branch condition is an assignment, the result of the select call is assigned to the target variable. | ||
|
||
<!-- markdownlint-disable MD046 --> | ||
|
||
!!! info "Select actions in the standard library" | ||
The standard library provides the following select actions: | ||
|
||
* `Channel#send_select_action` | ||
* `Channel#receive_select_action` | ||
* `Channel#receive_select_action?` | ||
* [`::timeout_select_action`](https://crystal-lang.org/api/toplevel.html#timeout_select_action(timeout:Time::Span):Channel::TimeoutAction-class-method) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Available first is not 100% accurate in MT or even if both are already available. I'm not sure how to frame the difference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If any actions are directly executable,
select_impl
immediately returns the result of the first action with delivery statedelivered
orclosed
. So IIUC "available first" should be good for that scenario.With multithreading everything is a bit more complicated, of course. But even there the action that first manages to activate the select context is chosen.
Maybe we just need a different word for "available"?