Enum Error 

pub enum Error {
    RepoPathNotAbsolute(PathBuf),
    RepoNotFound(PathBuf),
    NotADirectory(PathBuf),
    PathNotExist(PathBuf),
    PathNotRelative(PathBuf),
    EmptyKey,
    EmptyPassword,
    NoFile(&'static str),
    InvalidMagic,
    UnsupportedVersion(u8),
    UnsupportedAlgo(u8),
    CorruptHeader(PathBuf),
    EncryptFailed(String),
    DecryptFailed(String),
    Argon2(String),
    TruncatedChunk,
    FileTruncated,
    AtomicPersist(PathBuf, String),
    Git(String),
    HookExists(PathBuf),
    FilesNotEncrypted(usize, usize),
    Config(String),
    Io(Error),
    SaltCache(String),
    Other(String),
}

The error type returned by all public library functions.

Variants

RepoPathNotAbsolute(PathBuf)

repo argument was not an absolute path (lib callers must absolutize).

RepoNotFound(PathBuf)

Repository directory does not exist.

NotADirectory(PathBuf)

Repository path is not a directory.

PathNotExist(PathBuf)

Path supplied for the crypt list does not exist on disk.

PathNotRelative(PathBuf)

Expected a repo-relative path but got an absolute one.

EmptyKey

Master key/password is empty.

EmptyPassword

User entered an empty password interactively.

NoFile(&'static str)

Operation had no target files to act on.

InvalidMagic

File does not start with the GITSE magic / supported version.

UnsupportedVersion(u8)

Header advertises an unsupported format version.

UnsupportedAlgo(u8)

Header advertises an unsupported encryption algorithm.

CorruptHeader(PathBuf)

Header could not be parsed / validated.

EncryptFailed(String)

XChaCha20-Poly1305 encryption failure.

DecryptFailed(String)

XChaCha20-Poly1305 decryption failure (wrong password, corrupt or tampered data are all reported identically by AEAD).

Argon2(String)

Argon2 key derivation failure.

TruncatedChunk

Encrypted chunk is missing its ciphertext.

FileTruncated

Encrypted file ended without a final chunk.

AtomicPersist(PathBuf, String)

Atomic temp-file persist failed.

Git(String)

Underlying git invocation failed.

HookExists(PathBuf)

A pre-commit hook already exists at the target path.

FilesNotEncrypted(usize, usize)

check found unencrypted files. The count is (unencrypted, total).

Config(String)

Config file parse/serialize error.

Io(Error)

Generic I/O error.

SaltCache(String)

Rkyv (de)serialization failure for the salt cache.

Other(String)

Anything else — an opaque error message.

Trait Implementations

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

fn from(source: Error) -> Self

Converts to this type from the input type.