Struct spinoso_env::InvalidError

pub struct InvalidError(_);

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

#[must_use]

pub const fn new() -> Self

Construct a new, default invalid error.

Examples

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

#[must_use]

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()");

#[must_use]

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");

#[must_use]

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<&'static [u8]> for InvalidError

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

Performs the conversion.

impl From<&'static str> for InvalidError

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

Performs the conversion.

impl From<InvalidError> for Error

fn from(err: InvalidError) -> Self

Performs the conversion.

impl From<Vec<u8, Global>> for InvalidError

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

Performs the conversion.

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, 

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.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<InvalidError> for InvalidError

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<InvalidError> for InvalidError

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Eq for InvalidError

impl StructuralEq for InvalidError

impl StructuralPartialEq for InvalidError