Struct Error 

pub struct Error(/* private fields */);

Wrapper type for handling different Vouched error types uniformly.

This allows code that works with multiple Vouched wrappers to handle their validation errors through a single type. It supports automatic conversion through the ? operator.

Available with the alloc feature, which is enabled by the default std feature.

Examples

// Function that handles different Vouched error types uniformly.
fn process_errors() -> Result<(), Error> {
    // Any error implementing VouchedError can be converted into Error.
    let err = UserIdError::TooShort(TooShortError::new(1, 0));
    Err(Error::from(err))
}

// Inspect the concrete validation error kind.
let result = process_errors();
assert!(result.is_err());
let err = result.unwrap_err();
assert!(err.as_too_short().is_some());

Implementations

impl Error

pub fn new(inner: Box<dyn VouchedError>) -> Error

Wraps a boxed generated Vouched error.

pub fn into_inner(self) -> Box<dyn VouchedError>

Returns the wrapped generated Vouched error.

Trait Implementations

impl AsRef<dyn VouchedError> for Error

Available on crate feature alloc only.

fn as_ref(&self) -> &(dyn VouchedError + 'static)

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for Error

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

Formats the value using the given formatter.

impl Deref for Error

Available on crate feature alloc only.

type Target = dyn VouchedError

The resulting type after dereferencing.

fn deref(&self) -> &<Error as Deref>::Target

Dereferences the value.

impl Display for Error

Available on crate feature alloc only.

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

Formats the value using the given formatter.

impl Error for Error

Available on crate feature alloc only.

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl<E> From<E> for Error

where E: VouchedError,

Available on crate feature alloc only.

fn from(e: E) -> Error

Converts to this type from the input type.

impl Structable for Error

Available on crate feature valuable only.

fn definition(&self) -> StructDef<'_>

Returns the struct’s definition.

impl Valuable for Error

Available on crate feature valuable only.

fn as_value(&self) -> Value<'_>

Converts self into a Value instance.

fn visit(&self, visit: &mut dyn Visit)

Calls the relevant method on Visit to extract data from self.

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)

where Self: Sized,

Calls Visit::visit_primitive_slice() with self.