Enum AppPathError

pub enum AppPathError {
    ExecutableNotFound(String),
    InvalidExecutablePath(String),
}

Error type for AppPath operations.

This enum represents the possible failures that can occur when determining the executable location. These errors are rare in practice and typically indicate fundamental system issues.

When These Errors Occur

• ExecutableNotFound: When std::env::current_exe() fails

  • Very rare, but can happen in some embedded or heavily sandboxed environments
  • May occur if the executable has been deleted while running
  • Can happen in some containerized environments with unusual configurations

• InvalidExecutablePath: When the executable path is empty

  • Extremely rare, indicates a corrupted or broken system
  • May occur with custom or non-standard program loaders

These errors represent system-level failures that are typically unrecoverable for portable applications. Most applications should use the infallible API (new(), exe_dir()) and handle these rare cases through environment variables or fallback strategies.

Examples

use app_path::{AppPath, AppPathError};

// Handle errors explicitly
match AppPath::try_new("config.toml") {
    Ok(config) => {
        println!("Config path: {}", config.path().display());
    }
    Err(AppPathError::ExecutableNotFound(msg)) => {
        eprintln!("Cannot find executable: {}", msg);
        // Fallback to alternative configuration
    }
    Err(AppPathError::InvalidExecutablePath(msg)) => {
        eprintln!("Invalid executable path: {}", msg);
        // Fallback to alternative configuration
    }
}

Variants

ExecutableNotFound(String)

Failed to determine the current executable path.

This error occurs when std::env::current_exe() fails, which is rare but can happen in some embedded or heavily sandboxed environments.

InvalidExecutablePath(String)

Executable path is empty or invalid.

This error occurs when the system returns an empty executable path, which is extremely rare and indicates a corrupted or broken system.

Trait Implementations

impl Clone for AppPathError

fn clone(&self) -> AppPathError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppPathError

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

Formats the value using the given formatter.

impl Display for AppPathError

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

Formats the value using the given formatter.

impl Error for AppPathError

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 AppPathError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AppPathError

impl StructuralPartialEq for AppPathError