Enum SshServerError 

pub enum SshServerError {
    DockerfileNotFound {
        expected_path: PathBuf,
    },
    DockerBuildFailed {
        image_name: String,
        image_tag: String,
        dockerfile_dir: String,
        stdout: String,
        stderr: String,
    },
    ContainerStartFailed {
        source: TestcontainersError,
    },
    PortMappingFailed {
        source: TestcontainersError,
    },
    DockerCommandFailed {
        command: String,
        source: Error,
    },
    InvalidUtf8InPath {
        path: String,
    },
    DockerClientError {
        source: Box<DockerError>,
    },
}

Errors that can occur when working with SSH server containers

Variants

DockerfileNotFound

SSH server Dockerfile not found at expected location

Fields

expected_path: PathBuf

DockerBuildFailed

Docker build command failed

Fields

image_name: String

image_tag: String

dockerfile_dir: String

stdout: String

stderr: String

ContainerStartFailed

Failed to start SSH server container

Fields

source: TestcontainersError

PortMappingFailed

Failed to get mapped port for SSH container

Fields

source: TestcontainersError

DockerCommandFailed

Docker command execution failed

Fields

command: String

source: Error

InvalidUtf8InPath

Invalid UTF-8 in Dockerfile path

Fields

path: String

DockerClientError

Docker client operation failed

Fields

source: Box<DockerError>

Implementations

impl SshServerError

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::testing::integration::ssh_server::RealSshServerContainer;

if let Err(e) = RealSshServerContainer::start().await {
    eprintln!("Error: {e}");
    eprintln!("\nTroubleshooting:\n{}", e.help());
}

Trait Implementations

impl Debug for SshServerError

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

Formats the value using the given formatter.

impl Display for SshServerError

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

Formats the value using the given formatter.

impl Error for SshServerError

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.