Struct InvalidError

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

Error that indicates the underlying platform API returned an error.

This error is typically returned by the operating system and corresponds to EINVAL.

Examples

let err = InvalidError::new();
assert_eq!(err.message(), b"Errno::EINVAL");

let err = InvalidError::with_message("Invalid argument - setenv()");
assert_eq!(err.message(), b"Invalid argument - setenv()");

Implementations

impl InvalidError

pub const fn new() -> Self

Construct a new, default invalid error.

Examples

const ERR: InvalidError = InvalidError::new();
assert_eq!(ERR.message(), b"Errno::EINVAL");

pub const fn with_message(message: &'static str) -> Self

Construct a new, invalid error with a message.

Examples

const ERR: InvalidError = InvalidError::with_message("Invalid argument - setenv()");
assert_eq!(ERR.message(), b"Invalid argument - setenv()");

pub fn message(&self) -> &[u8]

Retrieve the exception message associated with this invalid error.

Examples

let err = InvalidError::new();
assert_eq!(err.message(), b"Errno::EINVAL");

pub fn into_message(self) -> Cow<'static, [u8]>

Consume this error and return the inner message.

This method allows taking ownership of this error’s message without an allocation.

Examples

let err = InvalidError::new();
assert_eq!(err.into_message(), Cow::Borrowed(b"Errno::EINVAL"));

Trait Implementations

impl Clone for InvalidError

fn clone(&self) -> InvalidError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InvalidError

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

Formats the value using the given formatter.

impl Display for InvalidError

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

Formats the value using the given formatter.

impl Error for InvalidError

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 From<&'static [u8]> for InvalidError

fn from(message: &'static [u8]) -> Self

Converts to this type from the input type.

impl From<&'static str> for InvalidError

fn from(message: &'static str) -> Self

Converts to this type from the input type.

impl From<InvalidError> for Error

fn from(err: InvalidError) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for InvalidError

fn from(message: Vec<u8>) -> Self

Converts to this type from the input type.

impl Hash for InvalidError

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for InvalidError

fn cmp(&self, other: &InvalidError) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for InvalidError

fn eq(&self, other: &InvalidError) -> 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 PartialOrd for InvalidError

fn partial_cmp(&self, other: &InvalidError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for InvalidError

impl StructuralPartialEq for InvalidError