Struct neodyn_xc::error::Error

#[must_use]pub struct Error { /* fields omitted */ }

The central error type for Neodyn Exchange.

Implementations

impl Error

pub fn new<S>(message: S) -> Self where
    S: Into<Cow<'static, str>>, 

Creates an error with the specified message, no cause, and a backtrace.

let error = Error::new("sample error message");
assert!(error.to_string().contains("sample error message"));
assert!(error.reason().is_none());
assert!(error.stack_trace().is_some());

pub fn with_cause<S, E>(message: S, cause: E) -> Self where
    S: Into<Cow<'static, str>>,
    E: ErrorExt + 'static, 

Creates an error with the specified message and cause. If the cause has no backtrace, this method will create it and add it to the new instance.

let cause = "not a bool".parse::<bool>().unwrap_err();
assert!(cause.cause().is_none());
assert!(cause.stack_trace().is_none());

let error = Error::with_cause("top-level message", cause);
assert!(error.to_string().contains("top-level message"));
assert!(error.cause().unwrap().to_string().contains(
    "provided string was not `true` or `false`"
));
assert!(error.stack_trace().is_some());

#[must_use]pub fn context<K>(&self) -> Option<&K::Value> where
    K: Key,
    K::Value: Debug + Send + Sync, 

Returns additional context info if any.

pub fn set_context<K>(&mut self, value: K::Value) -> Option<K::Value> where
    K: Key,
    K::Value: Debug + Send + Sync, 

Augments the error with additional context info.

pub fn with_context<K>(self, value: K::Value) -> Self where
    K: Key,
    K::Value: Debug + Send + Sync, 

Builder-style setter for agumenting the error with context info.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

Displays the error. If the alternate flag ({:#}) is set, also prints the full stack trace.

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

Formats the value using the given formatter.

impl Error for Error

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

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

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

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

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

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl Error for Error

fn custom<T: Display>(msg: T) -> Self

Used when a Serialize implementation encounters any error while serializing a type.

impl Error for Error

TODO(H2CO3): implement the rest of the (provided) methods by retaining the structured information itself, not only the formatted error message.

fn custom<T: Display>(msg: T) -> Self

Raised when there is general error when deserializing a type.

pub fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

pub fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

pub fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

pub fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

pub fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

pub fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

pub fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl ErrorExt for Error

fn reason(&self) -> Option<&(dyn ErrorExt + 'static)>

Similar to std::error::Error::source(), but with richer type info.

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

Returns the deepest possible backtrace, if any.

fn as_std_error(&self) -> &(dyn Error + 'static)

Until subtrait coercions are implemented, this helper method should return the receiver as an &std::error::Error trait object.

impl From<Error> for Error

fn from(error: Error) -> Self

Performs the conversion.

impl From<FloatIsNan> for Error

fn from(error: FloatIsNan) -> Self

Performs the conversion.

impl From<FromUtf8Error> for Error

fn from(error: FromUtf8Error) -> Self

Performs the conversion.

impl From<ParseBoolError> for Error

fn from(error: ParseBoolError) -> Self

Performs the conversion.

impl From<ParseFloatError> for Error

fn from(error: ParseFloatError) -> Self

Performs the conversion.

impl From<ParseIntError> for Error

fn from(error: ParseIntError) -> Self

Performs the conversion.

impl From<ParseNotNanError<ParseFloatError>> for Error

fn from(error: ParseNotNanError<ParseFloatError>) -> Self

Performs the conversion.

impl From<TryFromIntError> for Error

fn from(error: TryFromIntError) -> Self

Performs the conversion.

impl From<Utf8Error> for Error

fn from(error: Utf8Error) -> Self

Performs the conversion.

impl<'de> IntoDeserializer<'de, Error> for Value

type Deserializer = Self

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl<'de> IntoDeserializer<'de, Error> for &'de Value

type Deserializer = Self

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.