Struct Reason 

pub struct Reason {
    pub code: String,
    pub detail: Option<String>,
}

A structured reason: a stable code and an optional free-text detail. The code is what a comparison keys on; the detail is for a reader.

Fields

code: String

A stable, machine-readable code: an crate::error::ErrorKind::code for a fact carrying a report, or an emitter’s own (intake_bound, serial_key_busy, reentrant, ids_exhausted, layer_discarded, despawned_before_dispatch, never_served, settled, max_turns, …).

detail: Option<String>

What a reader wants to know.

Implementations

impl Reason

pub fn code(code: impl Into<String>) -> Self

A reason with a code and no detail.

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

A reason with a code and a detail.

pub fn from_report(report: &ErrorReport) -> Self

The reason an error report carries: its kind’s stable code (crate::error::ErrorKind::code), its message as the detail.

pub fn unknown() -> Self

The explicit unknown reason.

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reason

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Reason

impl PartialEq for Reason

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Reason

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Reason