Enum LuksError 

#[non_exhaustive]
pub enum LuksError {
    NotLuks {
        found: [u8; 6],
    },
    UnsupportedVersion {
        version: u16,
    },
    Unsupported {
        what: &'static str,
        value: String,
    },
    MalformedHeader {
        what: &'static str,
        need: usize,
        got: usize,
    },
    AuthenticationFailed,
    NoActiveKeyslot,
    Io(Error),
}

A LUKS parse or unlock failure. Every variant names the offending value so an investigator can act on it (never a bare “invalid”).

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.

NotLuks

The LUKS\xba\xbe magic is absent — not a LUKS container.

Fields

found: [u8; 6]

The first six bytes actually found.

UnsupportedVersion

The header version is neither 1 nor 2.

Fields

version: u16

The version field value.

Unsupported

The cipher/mode/hash combination has no validated decrypt path.

Fields

what: &'static str

Which axis is unsupported (cipher, mode, hash).

value: String

The offending value verbatim.

MalformedHeader

The header is structurally malformed (a field runs past the buffer).

Fields

what: &'static str

What was being read.

need: usize

Bytes needed.

got: usize

Bytes available.

AuthenticationFailed

No keyslot could be unlocked with the supplied passphrase, or the derived master key failed the mk-digest check (wrong passphrase).

NoActiveKeyslot

The container carries no active (enabled) keyslot.

Io(Error)

An I/O error reading the container.

Trait Implementations

impl Debug for LuksError

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

Formats the value using the given formatter.

impl Display for LuksError

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

Formats the value using the given formatter.

impl Error for LuksError

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 From<Error> for LuksError

fn from(source: Error) -> Self

Converts to this type from the input type.