Skip to content

Document breaking out of a named code block #140197

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

Merged
merged 2 commits into from
May 2, 2025
Merged
Changes from all commits
Commits
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
29 changes: 28 additions & 1 deletion library/std/src/keyword_docs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ mod as_keyword {}
///
/// When associated with `loop`, a break expression may be used to return a value from that loop.
/// This is only valid with `loop` and not with any other type of loop.
/// If no value is specified, `break;` returns `()`.
/// If no value is specified for `break;` it returns `()`.
/// Every `break` within a loop must return the same type.
///
/// ```rust
Expand All @@ -109,6 +109,33 @@ mod as_keyword {}
/// println!("{result}");
/// ```
///
/// It is also possible to exit from any *labelled* block returning the value early.
/// If no value is specified for `break;` it returns `()`.
///
/// ```rust
/// let inputs = vec!["Cow", "Cat", "Dog", "Snake", "Cod"];
///
/// let mut results = vec![];
/// for input in inputs {
/// let result = 'filter: {
/// if input.len() > 3 {
/// break 'filter Err("Too long");
/// };
///
/// if !input.contains("C") {
/// break 'filter Err("No Cs");
/// };
///
/// Ok(input.to_uppercase())
/// };
///
/// results.push(result);
/// }
///
/// // [Ok("COW"), Ok("CAT"), Err("No Cs"), Err("Too long"), Ok("COD")]
/// println!("{:?}", results)
/// ```
///
/// For more details consult the [Reference on "break expression"] and the [Reference on "break and
/// loop values"].
///
Expand Down
Loading