Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidKeyLength {
        actual: usize,
    },
    InvalidParameters,
    InvalidSegmentLength {
        actual: u32,
    },
    InvalidPlaintextLength {
        actual: usize,
        required: LengthRequirement,
    },
    InvalidHeaderLength {
        actual: usize,
    },
    InvalidHeaderParameters,
    InvalidHeaderTag,
    InvalidCiphertextLength {
        actual: usize,
        required: LengthRequirement,
    },
    InvalidSegmentPrefix,
    AuthenticationFailed,
    Closed,
    Truncated,
    SegmentLimit,
    OutputTooSmall {
        actual: usize,
        required: usize,
    },
    InvalidBufferState,
    ProviderSelectionRequired,
    LengthOverflow,
    RngFailure,
    CryptoFailure,
}

Errors returned by FLOE operations.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidKeyLength

A key did not have the required 32-byte length.

Fields

actual: usize

InvalidParameters

An operation combined values from different FLOE parameter sets.

InvalidSegmentLength

A segment length was outside Parameters::VALID_SEGMENT_LENGTHS.

Fields

actual: u32

InvalidPlaintextLength

A plaintext segment did not meet its required length.

Fields

actual: usize

required: LengthRequirement

InvalidHeaderLength

A header did not have the length required by crate::Header.

Fields

actual: usize

InvalidHeaderParameters

The encoded parameters in a header do not match the selected parameters.

InvalidHeaderTag

Header authentication failed.

InvalidCiphertextLength

A ciphertext segment did not meet its required length, or its encoded final-length prefix contradicted its actual length.

Fields

actual: usize

required: LengthRequirement

InvalidSegmentPrefix

An internal segment did not begin with 0xffff_ffff.

AuthenticationFailed

AES-GCM authentication failed.

Closed

An online encryptor or decryptor was used after its final segment.

Truncated

A message or online operation ended without producing or authenticating a final segment.

SegmentLimit

A segment position exceeded the AES-GCM FLOE limit.

OutputTooSmall

A caller-provided output buffer was too small.

Fields

actual: usize

required: usize

InvalidBufferState

A segment buffer was used in the wrong preparation state.

ProviderSelectionRequired

An operation omitted its provider while multiple providers were compiled.

LengthOverflow

A length calculation overflowed.

RngFailure

The selected provider could not obtain cryptographically secure bytes.

CryptoFailure

The selected cryptographic backend rejected an otherwise valid operation.

Implementations

impl Error

pub fn io_source(error: &Error) -> Option<&Self>

Returns the Error carried as the source of a wrapped std::io::Error.

The crate::io and crate::random_access adapters report FLOE failures as io::Error values with the original Error attached as the source. Use this helper to distinguish authentication, truncation, and policy failures from ordinary I/O errors:

use fast_floe::Error;

fn is_tampered(error: &std::io::Error) -> bool {
    matches!(Error::io_source(error), Some(Error::AuthenticationFailed))
}

Returns None for errors that did not originate in this crate, such as failures of the wrapped reader or writer.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error