Enum yaca::Error

pub enum Error {
    InvalidParameter,
    OutOfMemory,
    Internal,
    DataMismatch,
    InvalidPassword,
    Unknown(i32),
}

Enumeration of YACA error values returned from the C library

• All of the API functions return Result with an Error embedded.
• If Result::Err is returned it will contain one of those values.
• They are passed directly from the C YACA implementation.
• Some of the occurrences where YACA would return an error are mitigated by Rust's type safety.
• Some of the occurrences where YACA would return DataMismatch are converted to return bool in Result:Ok.

Variants

InvalidParameter

Invalid function parameter

OutOfMemory

Out of memory

Internal

Internal error

DataMismatch

Data mismatch

InvalidPassword

Invalid password

Unknown(i32)

Unknown error, should not happen

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 PartialEq<Error> for Error

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

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

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

This method tests for !=.

impl StructuralPartialEq for Error