Enum SshError 

pub enum SshError {
    ConnectivityTimeout {
        host_ip: String,
        attempts: u32,
        timeout_seconds: u32,
    },
    CommandFailed {
        source: CommandError,
    },
}

Errors that can occur during SSH operations

Variants

ConnectivityTimeout

Failed to establish SSH connectivity within timeout period

This typically means the SSH service is not yet available or the instance is still booting. Use .help() for detailed troubleshooting.

Fields

host_ip: String

attempts: u32

timeout_seconds: u32

CommandFailed

SSH command execution failed

The underlying SSH command execution encountered an error. Use .help() for detailed troubleshooting steps.

Fields

source: CommandError

Implementations

impl SshError

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

Get detailed troubleshooting guidance for this error

This method provides comprehensive troubleshooting steps that can be displayed to users when they need more help resolving the error.

Example

use torrust_tracker_deployer_lib::adapters::ssh::SshError;

let error = SshError::ConnectivityTimeout {
    host_ip: "192.168.1.100".to_string(),
    attempts: 30,
    timeout_seconds: 60,
};

// Display brief error
eprintln!("Error: {error}");

// Display detailed help when needed
eprintln!("\nTroubleshooting:\n{}", error.help());

Trait Implementations

impl Debug for SshError

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

Formats the value using the given formatter.

impl Display for SshError

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

Formats the value using the given formatter.

impl Error for SshError

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<SshError> for ProvisionCommandHandlerError

fn from(source: SshError) -> Self

Converts to this type from the input type.

impl Traceable for SshError

fn trace_format(&self) -> String

Generate a formatted trace entry for this error

fn trace_source(&self) -> Option<&dyn Traceable>

Get the underlying source error that implements Traceable, if any

fn error_kind(&self) -> ErrorKind

Get the error kind for high-level categorization