Enum VaultError

pub enum VaultError {
    NoPassword,
    InvalidFormat,
    VaultIdNotFound,
    DecryptionFailed,
    EncryptionFailed,
}

Specialized error types for Ansible Vault operations.

These errors provide specific context for vault-related failures, making it easier to handle different types of vault errors appropriately.

Examples

use ansible::{VaultError, AnsibleError};

// Handle specific vault errors
let vault_result: Result<(), AnsibleError> = Ok(());
match vault_result {
    Err(AnsibleError::ConfigError(message)) if message.contains("password") => {
        eprintln!("Please provide a vault password");
    }
    Err(AnsibleError::CommandFailed { message, .. }) if message.contains("decrypt") => {
        eprintln!("Failed to decrypt - check your password");
    }
    _ => {}
}

Variants

NoPassword

Vault password was not provided when required

This error occurs when attempting vault operations without specifying a password file, vault ID, or interactive password.

InvalidFormat

The vault file has an invalid or corrupted format

This error occurs when the encrypted file doesn’t match the expected Ansible Vault format.

VaultIdNotFound

The specified vault ID was not found

This error occurs when using multiple vault IDs and the specified ID is not available or configured.

DecryptionFailed

Decryption operation failed

This error occurs when the vault password is incorrect or the encrypted data is corrupted.

EncryptionFailed

Encryption operation failed

This error occurs when the encryption process fails, possibly due to file permissions or disk space issues.

Trait Implementations

impl Clone for VaultError

fn clone(&self) -> VaultError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VaultError

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

Formats the value using the given formatter.

impl Display for VaultError

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

Formats the value using the given formatter.

impl Error for VaultError

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.