Struct ErrorWith

Source
pub struct ErrorWith<T> { /* private fields */ }
Expand description

Base error type for PAM operations (possibly with a payload)

Errors originate from the PAM library, PAM modules or helper structs in this crate. Currently no custom instances are supported.

Implementations§

Source§

impl<T> ErrorWith<T>

Source

pub const fn code(&self) -> ErrorCode

The error code.

Source

pub fn message(&self) -> Option<&str>

Text representation of the error code, if available.

Source

pub const fn payload(&self) -> Option<&T>

Returns a reference to an optional payload.

Source

pub fn take_payload(&mut self) -> Option<T>

Takes the payload out of the error message.

If a payload exists in this error, it will be moved into the returned Option. All further calls to payload() and take_payload() will return None.

Source

pub fn map<U>(self, func: impl FnOnce(T) -> U) -> ErrorWith<U>

Maps the error payload to another type

Source

pub fn into_without_payload(self) -> Error

Removes the payload and converts to Error

Source§

impl ErrorWith<NoPayload>

Source

pub fn into_with_payload<T>(self, payload: T) -> ErrorWith<T>

Adds the payload to the error message and returns a corresponding ErrorWith<T> instance.

Source

pub fn into<T>(self) -> ErrorWith<T>

Converts the error message into a ErrorWith<T> instance without a payload.

Trait Implementations§

Source§

impl<T: Clone> Clone for ErrorWith<T>

Source§

fn clone(&self) -> ErrorWith<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for ErrorWith<T>

Source§

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

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

impl<T> Display for ErrorWith<T>

Source§

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

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

impl<T> Error for ErrorWith<T>

1.30.0 · Source§

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

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

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
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<T: Send + Sync + Debug + 'static> From<ErrorWith<T>> for Error

Automatic wrapping in std::io::Error (if payload type is compatible).

fn main() -> std::result::Result<(), std::io::Error> {
    some_succeeding_pam_function()?;
    Ok(())
}
fn main() -> std::result::Result<(), std::io::Error> {
    some_failing_pam_function()?;
    Ok(())
}
Source§

fn from(error: ErrorWith<T>) -> Self

Converts to this type from the input type.
Source§

impl<T> Hash for ErrorWith<T>
where T: Hash,

Source§

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

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<T> PartialEq for ErrorWith<T>
where T: PartialEq,

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> Eq for ErrorWith<T>
where T: Eq,

Auto Trait Implementations§

§

impl<T> Freeze for ErrorWith<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ErrorWith<T>
where T: RefUnwindSafe,

§

impl<T> Send for ErrorWith<T>
where T: Send,

§

impl<T> Sync for ErrorWith<T>
where T: Sync,

§

impl<T> Unpin for ErrorWith<T>
where T: Unpin,

§

impl<T> UnwindSafe for ErrorWith<T>
where T: 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.