Struct relay_protocol::Error

pub struct Error { /* private fields */ }

An error with an enumerable kind and optional data.

Implementations

impl Error

pub fn new(kind: ErrorKind) -> Self

Creates a new error without data.

pub fn with<F>(kind: ErrorKind, f: F) -> Self

where F: FnOnce(&mut Self),

Creates a new error and allows instant modification in a function.

pub fn invalid<S>(reason: S) -> Self

where S: Display,

Creates an invalid data error with a plain text reason.

pub fn expected(expectation: &str) -> Self

Creates an error that describes an invalid value.

pub fn nonempty() -> Self

Creates an error that describes an expected non-empty value.

pub fn nonempty_string() -> Self

Creates an error that describes an expected non-empty string.

pub fn kind(&self) -> &ErrorKind

Returns the kind of this error.

pub fn data(&self) -> impl Iterator<Item = (&str, &Value)>

Returns an iterator over the data of this error.

pub fn insert<K, V>(&mut self, key: K, value: V) -> Option<Value>

where K: Into<String>, V: Into<Value>,

Inserts a new key into the data bag of this error.

pub fn get<K>(&self, key: K) -> Option<&Value>

where K: AsRef<str>,

Retrieves a key from the data bag of this error.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<ErrorKind> for Error

fn from(kind: ErrorKind) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Error

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Error