Enum ichen_openprotocol::OpenProtocolError

pub enum OpenProtocolError<'a> {
    EmptyField(&'a str),
    InvalidField {
        field: &'a str,
        value: Cow<'a, str>,
        description: Cow<'a, str>,
    },
    InconsistentState(&'a str),
    InconsistentField(&'a str),
    ConstraintViolated(Cow<'a, str>),
    JsonError(Error),
    SystemError(Cow<'a, str>),
}

Result error type.

Variants

EmptyField(&'a str)

The value of a field is the empty string "" or containing all white-spaces, which is not allowed as value of that field.

InvalidField

The value of a field is not valid.

Fields of InvalidField

field: &'a strvalue: Cow<'a, str>description: Cow<'a, str>

InconsistentState(&'a str)

The value of a field is not consistent with the matching value in the state.

InconsistentField(&'a str)

The value of a field is not consistent with the matching value in the Controller structure.

ConstraintViolated(Cow<'a, str>)

An enforced constraint is broken.

JsonError(Error)

Error when serializing/deserializing JSON.

SystemError(Cow<'a, str>)

An unexpected system error.

Trait Implementations

impl<'a> Debug for OpenProtocolError<'a>

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

Formats the value using the given formatter.

impl<'a> Display for OpenProtocolError<'a>

fn fmt(&self, _derive_more_display_formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'_> Eq for OpenProtocolError<'_>

impl<'_> Error for OpenProtocolError<'_>

fn description(&self) -> &str

This method is soft-deprecated.

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

impl<'_> From<OpenProtocolError<'_>> for String

fn from(error: OpenProtocolError) -> Self

Performs the conversion.

impl<'_> PartialEq<OpenProtocolError<'_>> for OpenProtocolError<'_>

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

Implement PartialEq for OpenProtocolError.

Most variants already implement PartialEq and are simply delegated.

The only variant that doesn't automatically implement PartialEq is JsonError which encapsulates a serde::error::Error object that does not implement PartialEq. In this case, we test for equality simply by comparing the Debug output of self and other.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.