Enum sp_std::ops::ControlFlow

[−] Show declaration

pub enum ControlFlow<C, B> {
    Continue(C),
    Break(B),
}

🔬 This is a nightly-only experimental API. (control_flow_enum)

new API

[−] Expand description

Used to make try_fold closures more like normal loops

Variants

Continue(C)

🔬 This is a nightly-only experimental API. (control_flow_enum)

new API

[−] Expand description

Continue in the loop, using the given value for the next iteration

Break(B)

🔬 This is a nightly-only experimental API. (control_flow_enum)

new API

[−] Expand description

Exit the loop, yielding the given value

Implementations

impl<C, B> ControlFlow<C, B>[−]

pub fn break_value(self) -> Option<B>[−]

🔬 This is a nightly-only experimental API. (control_flow_enum)

new API

Converts the ControlFlow into an Option which is Some if the ControlFlow was Break and None otherwise.

impl<R> ControlFlow<<R as Try>::Ok, R> where
    R: Try, [−]

pub fn from_try(r: R) -> ControlFlow<<R as Try>::Ok, R>[−]

🔬 This is a nightly-only experimental API. (control_flow_enum)

new API

Create a ControlFlow from any type implementing Try.

pub fn into_try(self) -> R[−]

🔬 This is a nightly-only experimental API. (control_flow_enum)

new API

Convert a ControlFlow into any type implementing Try;

impl<B> ControlFlow<(), B>[−]

pub const CONTINUE: ControlFlow<(), B>[−][−]

🔬 This is a nightly-only experimental API. (control_flow_enum)

new API

It's frequently the case that there's no value needed with Continue, so this provides a way to avoid typing (()), if you prefer it.

Examples

#![feature(control_flow_enum)]
use std::ops::ControlFlow;

let mut partial_sum = 0;
let last_used = (1..10).chain(20..25).try_for_each(|x| {
    partial_sum += x;
    if partial_sum > 100 { ControlFlow::Break(x) }
    else { ControlFlow::CONTINUE }
});
assert_eq!(last_used.break_value(), Some(22));

impl<C> ControlFlow<C, ()>[−]

pub const BREAK: ControlFlow<C, ()>[−][−]

🔬 This is a nightly-only experimental API. (control_flow_enum)

new API

APIs like try_for_each don't need values with Break, so this provides a way to avoid typing (()), if you prefer it.

Examples

#![feature(control_flow_enum)]
use std::ops::ControlFlow;

let mut partial_sum = 0;
(1..10).chain(20..25).try_for_each(|x| {
    if partial_sum > 100 { ControlFlow::BREAK }
    else { partial_sum += x; ControlFlow::CONTINUE }
});
assert_eq!(partial_sum, 108);

Trait Implementations

impl<C, B> Clone for ControlFlow<C, B> where
    B: Clone,
    C: Clone, [+]

[+] Show hidden undocumented items

fn clone(&self) -> ControlFlow<C, B>[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<C, B> Copy for ControlFlow<C, B> where
    B: Copy,
    C: Copy, 

impl<C, B> Debug for ControlFlow<C, B> where
    B: Debug,
    C: Debug, [+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl<C, B> PartialEq<ControlFlow<C, B>> for ControlFlow<C, B> where
    B: PartialEq<B>,
    C: PartialEq<C>, [+]

[+] Show hidden undocumented items

fn eq(&self, other: &ControlFlow<C, B>) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ControlFlow<C, B>) -> bool[−]

This method tests for !=.