Enum Runner

#[non_exhaustive]
pub enum Runner {
    Docker(Docker),
    Podman(Podman),
    Nerdctl(Nerdctl),
}

The test containers runner

Use the Runner::auto, Runner::docker, Runner::podman, Runner::nerdctl functions to create your runner

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.

Docker(Docker)

Docker

Podman(Podman)

Podman

Nerdctl(Nerdctl)

Nerdctl

Implementations

impl Runner

pub fn auto() -> Result<Self, RunnerError>

Find an available runner

Errors

Fail if no runner is available

pub fn docker() -> Result<Self, RunnerError>

Create a docker runner

Errors

Fail if the docker command is not found Fail if the docker command version is unsupported

pub fn podman() -> Result<Self, RunnerError>

Create a podman runner

Errors

Fail if the podman command is not found Fail if the podman command version is unsupported

pub fn nerdctl() -> Result<Self, RunnerError>

Create a nerdctl runner

Errors

Fail if the nerdctl command is not found Fail if the nerdctl command version is unsupported

impl Runner

pub async fn start<I>(&self, image: I) -> Result<Container<I>, RunnerError>

where I: ToRunnableContainer,

Start a runnable container

The default RunOption is used

Errors

Fail if we cannot launch the container

pub async fn start_with_options<I>( &self, image: I, options: RunOption, ) -> Result<Container<I>, RunnerError>

where I: ToRunnableContainer,

Start a runnable container with option

Errors

Fail if we cannot launch the container

pub async fn create_network( &self, name: impl Into<String>, ) -> Result<Network, RunnerError>

Create a network

Errors

Could fail if we cannot execute the command

pub async fn create_volume( &self, name: impl Into<String>, ) -> Result<VolumeName, RunnerError>

Create a container volume

Errors

Could fail if we cannot execute the command

pub async fn network_ip<I>( &self, container: &Container<I>, network: &Network, ) -> Result<Ipv4Addr, RunnerError>

where I: ToRunnableContainer,

Get the container IP for a custom network

Errors

Fail if the network is not custom Fail if the IP is not found Could fail if we cannot execute the inspect command

pub async fn container_host_ip(&self) -> Result<Ipv4Addr, RunnerError>

Get the container host ip

Errors

Could fail if we cannot execute the inspect command

pub async fn exec<I, S>( &self, container: &Container<I>, exec_command: impl IntoIterator<Item = S> + Debug, ) -> Result<String, RunnerError>

where S: Into<String>, I: ToRunnableContainer,

Execute a command into the container

Errors

Could fail if we cannot execute the command

pub fn stop<I>(&self, container: &Container<I>) -> Result<(), RunnerError>

where I: ToRunnableContainer,

Stop the container

This method is call during the crate::Container drop if it’s not detached

Errors

Fail if we cannot launch the container

impl Runner

pub async fn compose_start<I>( &self, images: I, ) -> Result<ComposeContainers<I>, RunnerError>

where I: ToRunnableComposeContainers,

Run a compose container with the default options

Errors

Fail if the compose containers cannot be started

pub async fn compose_start_with_options<I>( &self, images: I, options: ComposeRunOption, ) -> Result<ComposeContainers<I>, RunnerError>

where I: ToRunnableComposeContainers,

Run compose containers with options

Errors

Fail if the compose containers cannot be started

impl Runner

pub async fn copy_to_volume( &self, volume: VolumeName, path: impl AsRef<Path>, ) -> Result<(), CopyError>

Copy a file or a folder into a volume

Errors

Fail if the path does not exists Fail if the path does not have a parent Fail if the path does not have a name Fail if the we cannot launch the copy into the containers

Trait Implementations

impl Clone for Runner

fn clone(&self) -> Runner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Runner

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

Formats the value using the given formatter.

impl Display for Runner

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

Formats the value using the given formatter.

impl PartialEq for Runner

fn eq(&self, other: &Runner) -> 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 Runner

impl StructuralPartialEq for Runner