Struct Failure 

pub struct Failure { /* private fields */ }

Why one command failed.

Every member is always written, source and retry_after_seconds as null when they have nothing to say, so a caller reads a fixed shape.

Implementations

impl Failure

What a linking caller reads.

The same members the failure document writes, through Failure::class, Failure::kind, Failure::source, Failure::message and Failure::retry_after_seconds, so a Rust caller never serialises a failure to branch on it. They read and nothing more: no caller can build or alter a failure whose class disagrees with classify.

pub fn decided(kind: &str, message: impl Into<String>) -> Self

A failure this product decided on its own, with no source behind it.

pub fn class(&self) -> FailureClass

Whether repeating the request unchanged could change the answer — the one closed value a caller branches on, as classify decided it for this failure’s cause.

pub fn kind(&self) -> &str

What failed: the causing source error’s own kind when a source caused it, and otherwise this product’s kebab-case name for the failure, such as no-such-item.

pub fn source(&self) -> Option<&SourceName>

The configured source the failure came from, or None when none did.

pub fn message(&self) -> &str

What a person reads: the stderr line without its prefix.

pub fn retry_after_seconds(&self) -> Option<u64>

How many seconds a rate limit asked the caller to wait, or None when it named no wait.

Trait Implementations

impl Clone for Failure

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 Failure

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Failure

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ConfigError> for Failure

fn from(error: &ConfigError) -> Self

A configuration this product will not run on. No source caused it — a plugin refusing its own block is refused here, at load, before any source is built.

impl From<&EngineError> for Failure

fn from(error: &EngineError) -> Self

Converts to this type from the input type.

impl JsonSchema for Failure

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Failure

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Failure

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 Failure