Enum EncryptionError 

#[non_exhaustive]
pub enum EncryptionError {
    NeedPassword,
    WrongPassword,
    NotDecryptable(String),
    Malformed(String),
}

Why an encrypted document could not be opened.

Only NeedPassword and WrongPassword are solved by a password (needs_password); the other two say the file cannot be read however it is asked. Non-exhaustive: a reader may learn to tell another case apart.

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.

NeedPassword

No password was given and none the reader tries by itself (a format’s documented default) opens the document.

WrongPassword

A password was given and neither it nor a default one opens it.

NotDecryptable(String)

The document is encrypted in a way this reader does not decrypt (ODF package encryption, XOR obfuscation, an iWork package, a WordPerfect file, an unknown cipher), so no password would help. The payload names the scheme.

Malformed(String)

The document is encrypted, but its encryption header is damaged or outside the specification’s bounds. The payload names the field.

Implementations

impl EncryptionError

pub fn needs_password(&self) -> bool

Whether a (different) password would open the document — the two cases worth prompting a user for.

pub fn code(&self) -> &'static str

A stable machine-readable name for the case — what an HTTP error body or a log line carries: password_required, wrong_password, not_decryptable, malformed_encryption.

Trait Implementations

impl Clone for EncryptionError

fn clone(&self) -> EncryptionError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptionError

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

Formats the value using the given formatter.

impl Display for EncryptionError

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

Formats the value using the given formatter.

impl Eq for EncryptionError

impl Error for EncryptionError

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 EncryptionError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EncryptionError