Struct pam_client::ErrorWith

#[must_use]pub struct ErrorWith<T> { /* fields omitted */ }

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

impl<T> ErrorWith<T>

pub fn with_payload(
    handle: &mut PamHandle,
    code: ReturnCode,
    payload: Option<T>
) -> ErrorWith<T>

Creates a new Error that takes a payload.

Functions that consume a struct can use the payload to transfer back ownership in error cases.

pub const fn code(&self) -> ReturnCode

The error code.

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

Text representation of the error code, if available.

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

Returns a reference to an optional payload.

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.

pub fn drop_payload(self) -> Error

Drops any payload off the error message, if one exists.

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

impl ErrorWith<NoPayload>

pub fn new(handle: &mut PamHandle, code: ReturnCode) -> Error

Creates a new Error.

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.

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

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ErrorWith<T>

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

Formats the value using the given formatter.

impl<T> Display for ErrorWith<T>

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

Formats the value using the given formatter.

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

impl<T> Error for ErrorWith<T>

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

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

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

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

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

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.