Enum AutosshError 

#[non_exhaustive]
pub enum AutosshError {
    SshNotFound {
        searched: Vec<PathBuf>,
    },
    MonitorBindFailed {
        port: u16,
        source: Error,
    },
    MaxStartReached {
        attempts: u32,
    },
    MaxLifetimeReached,
    PidfileWrite {
        path: PathBuf,
        source: Error,
    },
    LogfileWrite {
        path: PathBuf,
        source: Error,
    },
    Io(Error),
    Daemonize {
        reason: String,
    },
    Internal(&'static str),
}

Errors returned by the rusty-autossh library API.

Send + Sync + 'static per SC-009. #[non_exhaustive] per AD-014 so additive variants are not a breaking change.

source() returns the wrapped inner error for wrapping variants (those holding a source: io::Error field, the #[from] Io variant) and None for leaf variants (no inner source).

Example

use std::io;
use rusty_autossh::AutosshError;

// io::Error converts via `#[from]` (AD-014).
let io_err = io::Error::new(io::ErrorKind::NotFound, "boom");
let err: AutosshError = io_err.into();
match err {
    AutosshError::Io(_) => {}
    _ => unreachable!(),
}

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.

SshNotFound

The ssh binary could not be resolved from AUTOSSH_PATH or any entry in the host PATH. The searched field enumerates the directories probed (in walk order) for diagnostic surfacing.

Fields

searched: Vec<PathBuf>

Directories probed during the PATH walk (or the verbatim AUTOSSH_PATH value when that env var was set).

MonitorBindFailed

Failed to bind a monitor-port tokio::net::TcpListener on 127.0.0.1:<port> (typically EADDRINUSE or a permission error).

Fields

port: u16

The TCP port that failed to bind.

source: Error

Underlying OS error.

MaxStartReached

The consecutive-retry counter reached the AUTOSSH_MAXSTART cap (or --max-start <n> CLI override). Maps to upstream’s autossh: maximum retries reached stderr.

Fields

attempts: u32

Number of consecutive child-spawn attempts performed before the cap was hit.

MaxLifetimeReached

AUTOSSH_MAXLIFETIME (or --max-lifetime <secs>) elapsed. Clean self-termination; supervisor exits 0.

PidfileWrite

Atomic write of the pidfile failed at startup.

Fields

path: PathBuf

Pidfile path that failed to write.

source: Error

Underlying OS error.

LogfileWrite

Failed to open/append to the logfile.

Fields

path: PathBuf

Logfile path that failed to write.

source: Error

Underlying OS error.

Io(Error)

Generic I/O error surfaced from underlying syscalls.

Daemonize

The daemonize crate or Windows CreateProcessW self-respawn failed during -f background mode setup.

Fields

reason: String

Human-readable reason for the daemonize failure.

Internal(&'static str)

An internal invariant was violated. The &'static str payload is a short diagnostic tag (never user-supplied content).

Trait Implementations

impl Debug for AutosshError

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

Formats the value using the given formatter.

impl Display for AutosshError

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

Formats the value using the given formatter.

impl Error for AutosshError

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 AutosshError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<StrictError> for AutosshError

fn from(_err: StrictError) -> Self

Converts to this type from the input type.