Struct TurnStop 

pub struct TurnStop {
    pub class: TurnStopClass,
    pub code: TurnStopCode,
    pub detail: String,
}

A typed control-flow abort on the turn path.

Fields

class: TurnStopClass

How the turn should be treated.

code: TurnStopCode

What stopped it.

detail: String

The message the turn would have carried anyway; this is the whole of the Display, so tagging never changes what an error stringifies to.

Implementations

impl TurnStop

pub fn new( class: TurnStopClass, code: TurnStopCode, detail: impl Into<String>, ) -> Self

Build a stop with the given classification and message.

pub fn recoverable(code: TurnStopCode, detail: impl Into<String>) -> Self

A stop whose condition may clear on its own.

pub fn close_out(code: TurnStopCode, detail: impl Into<String>) -> Self

A stop that ends the turn but leaves its work worth reporting.

pub fn fatal(code: TurnStopCode, detail: impl Into<String>) -> Self

A stop that cannot be retried.

Trait Implementations

impl Clone for TurnStop

fn clone(&self) -> TurnStop

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TurnStop

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

Formats the value using the given formatter.

impl Display for TurnStop

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

Formats the value using the given formatter.

impl Eq for TurnStop

impl Error for TurnStop

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for TurnStop

fn eq(&self, other: &TurnStop) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TurnStop