Skip to main content

Described

Struct Described 

Source
pub struct Described<K> { /* private fields */ }
Available on crate feature alloc only.
Expand description

An envelope that collects error descriptions

§Collects

  • description
  • error kind

§When To Use

When you primarily want to return error codes, but you also think some detailed error string is okay to pass back to the client.

§Example Display

static error code: detailed dynamic error message

Trait Implementations§

Source§

impl<K: Clone> Clone for Described<K>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K: Debug> Debug for Described<K>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<K: ErrorKind> Display for Described<K>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<K: Eq> Eq for Described<K>

Source§

impl<K: ErrorKind> ErrorContext for Described<K>

Source§

fn with_context<C, F>(self, _context: F) -> Self
where C: Context, F: FnOnce() -> C,

Provide human-readable context about why an error occurred. Read more
Source§

impl<K: ErrorKind> ErrorEnvelope for Described<K>

Source§

type Kind = K

The ErrorKind contained within this envelope.
Source§

type Envelope<T: ErrorKind> = Described<T>

How to map one ErrorKind to another within this envelope.
Source§

fn convert<T>(self) -> Self::Envelope<T>
where T: ErrorKind + From<Self::Kind>,

Converts the underlying error kind into a compatible error kind.
Source§

fn error_kind(&self) -> Self::Kind

The error kind held within this envelope.
Source§

fn new(kind: Self::Kind) -> Self

Constructs a new envelope with the provided error_kind.
Source§

fn with_description<S>(kind: Self::Kind, description: S) -> Self
where S: StaticString,

Constructs a new envelope with the provided error_kind and description.
Source§

impl<K: ErrorKind> From<Described<K>> for Diagnostic<K>

Source§

fn from(orig: Described<K>) -> Self

Converts to this type from the input type.
Source§

impl<K: ErrorKind> From<Described<K>> for Located<K>

Source§

fn from(orig: Described<K>) -> Self

Converts to this type from the input type.
Source§

impl<K: ErrorKind> From<Diagnostic<K>> for Described<K>

Source§

fn from(orig: Diagnostic<K>) -> Self

Converts to this type from the input type.
Source§

impl<K: ErrorKind> From<K> for Described<K>

Source§

fn from(orig: K) -> Self

Converts to this type from the input type.
Source§

impl<K: ErrorKind> From<Located<K>> for Described<K>

Source§

fn from(orig: Located<K>) -> Self

Converts to this type from the input type.
Source§

impl<K: Hash> Hash for Described<K>

Source§

fn hash<H>(&self, state: &mut H)
where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<K: Ord> Ord for Described<K>

Source§

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl<K: PartialEq> PartialEq for Described<K>

Source§

fn eq(&self, rhs: &Described<K>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<K: PartialEq> PartialEq<Described<K>> for Diagnostic<K>

Source§

fn eq(&self, rhs: &Described<K>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<K: PartialEq> PartialEq<Described<K>> for Located<K>

Source§

fn eq(&self, rhs: &Described<K>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<K: PartialEq> PartialEq<Diagnostic<K>> for Described<K>

Source§

fn eq(&self, rhs: &Diagnostic<K>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<K: PartialEq> PartialEq<K> for Described<K>

Source§

fn eq(&self, rhs: &K) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<K: PartialEq> PartialEq<Located<K>> for Described<K>

Source§

fn eq(&self, rhs: &Located<K>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<K: PartialOrd> PartialOrd for Described<K>

Source§

fn partial_cmp(&self, rhs: &Described<K>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<K: PartialOrd> PartialOrd<Described<K>> for Diagnostic<K>

Source§

fn partial_cmp(&self, rhs: &Described<K>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<K: PartialOrd> PartialOrd<Described<K>> for Located<K>

Source§

fn partial_cmp(&self, rhs: &Described<K>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<K: PartialOrd> PartialOrd<Diagnostic<K>> for Described<K>

Source§

fn partial_cmp(&self, rhs: &Diagnostic<K>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<K: PartialOrd> PartialOrd<K> for Described<K>

Source§

fn partial_cmp(&self, rhs: &K) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<K: PartialOrd> PartialOrd<Located<K>> for Described<K>

Source§

fn partial_cmp(&self, rhs: &Located<K>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Auto Trait Implementations§

§

impl<K> Forget for Described<K>

§

impl<K> Freeze for Described<K>
where K: Freeze,

§

impl<K> Move for Described<K>

§

impl<K> RefUnwindSafe for Described<K>
where K: RefUnwindSafe,

§

impl<K> Send for Described<K>
where K: Send,

§

impl<K> Sync for Described<K>
where K: Sync,

§

impl<K> Unpin for Described<K>
where K: Unpin,

§

impl<K> UnsafeUnpin for Described<K>
where K: UnsafeUnpin,

§

impl<K> UnwindSafe for Described<K>
where K: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Context for T
where T: Debug + Display + Send + Sync + 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.