Skip to content

doc: mention that receive/1 and ExUnit.Assertions.assert_receive/4 removes messages #14743

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

Merged
merged 2 commits into from
Sep 3, 2025
Merged

doc: mention that receive/1 and ExUnit.Assertions.assert_receive/4 removes messages #14743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbd9392
doc: mention receive/1 and assert_receive/4 consumes messages
andremaker Sep 3, 2025
604d937
Apply suggestions from code review
josevalim Sep 3, 2025
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
2 changes: 1 addition & 1 deletion lib/elixir/lib/kernel/special_forms.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2355,7 +2355,7 @@ defmodule Kernel.SpecialForms do
defmacro try(args), do: error!([args])

@doc """
Checks if there is a message matching any of the given clauses in the current
Consumes the first message matching any of the given clauses in the current
process mailbox.

If there is no matching message, the current process waits until a matching
Expand Down
12 changes: 8 additions & 4 deletions lib/ex_unit/lib/ex_unit/assertions.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,8 +459,10 @@ defmodule ExUnit.Assertions do
The default timeout duration is determined by the `assert_receive_timeout` option,
which can be set using `ExUnit.configure/1`. This option defaults to 100 milliseconds.

The `pattern` argument must be a match pattern. Flunks with `failure_message`
if a message matching `pattern` is not received.
The `pattern` argument must be a match pattern.

Flunks with `failure_message` if a message matching `pattern` is not received.
If a message matches, it is also removed from the process mailbox.

## Examples

Expand All @@ -487,8 +489,10 @@ defmodule ExUnit.Assertions do
Asserts that a message matching `pattern` was received and is in the
current process' mailbox.

The `pattern` argument must be a match pattern. Flunks with `failure_message`
if a message matching `pattern` was not received.
The `pattern` argument must be a match pattern.

Flunks with `failure_message` if a message matching `pattern` was not received.
If a message matches, it is also removed from the process mailbox.

Timeout is set to `0`, so there is no waiting time.

Expand Down