Skip to main content

Error

Struct Error 

Source
#[non_exhaustive]
pub struct Error { pub kind: ErrorKind, /* private fields */ }
Expand description

Describes an arbitrary error that prevented an operation from completing.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§kind: ErrorKind

The general kind of the error. Code that decides how to respond to an error should read only this field in making its decision.

Implementations§

Source§

impl Error

Source

pub fn new(kind: ErrorKind, extra: String) -> Self

Source

pub fn from_kind(kind: ErrorKind) -> Self

Source

pub fn failed(description: String) -> Self

Source

pub fn overloaded(description: String) -> Self

Source

pub fn disconnected(description: String) -> Self

Source

pub fn unimplemented(description: String) -> Self

Source

pub fn extra(&self) -> &str

Returns any extra human-readable context attached to this error, or "" if none.

Source

pub fn write_fmt(&mut self, fmt: Arguments<'_>)

Appends formatted text to this error’s extra context. Does nothing if the "alloc" feature is not enabled. This is intended to be used with the write!() macro from core.

Source

pub fn get_detail(&self, detail_id: u64) -> Option<&[u8]>

Returns the detail payload associated with detail_id, if present.

Details can be attached to an error returned by an RPC server method and retrieved on the client after awaiting the call. Each detail type should use a unique 64-bit ID (typically generated with capnp id).

Source

pub fn get_details(&self) -> &[ErrorDetail]

Returns all ErrorDetail entries attached to this error.

Source

pub fn set_detail(&mut self, detail_id: u64, data: Vec<u8>)

Attaches a detail payload keyed by detail_id to this error, replacing any existing payload with the same detail_id.

Each detail type should use a unique 64-bit ID (typically generated with capnp id).

const VALIDATION_ERROR: u64 = 0x9935_c2b4_7d94_809c;
let mut err = capnp::Error::failed("invalid".into());
err.set_detail(VALIDATION_ERROR, b"field x must be positive".to_vec());
assert_eq!(err.get_detail(VALIDATION_ERROR), Some(&b"field x must be positive"[..]));
Source

pub fn release_detail(&mut self, detail_id: u64) -> Option<Vec<u8>>

Removes and returns the detail payload associated with detail_id, if present.

Trait Implementations§

Source§

impl Clone for Error

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 Debug for Error

Source§

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

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

impl Display for Error

Source§

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

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

impl Error for Error

Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<Error> for Error

Available on crate feature std only.
Source§

fn from(err: Error) -> Self

Converts to this type from the input type.
Source§

impl From<FromUtf8Error> for Error

Available on crate feature alloc only.
Source§

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.
Source§

impl From<NotInSchema> for Error

Source§

fn from(e: NotInSchema) -> Self

Converts to this type from the input type.
Source§

impl From<Utf8Error> for Error

Source§

fn from(err: Utf8Error) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Forget for Error

§

impl Freeze for Error

§

impl Move for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

§

impl UnwindSafe for Error

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> 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.