Struct testcontainers::Container

pub struct Container<'d, D, I> where
    D: Docker,
    I: Image,  { /* fields omitted */ }

Represents a running docker container.

Containers have a custom destructor that removes them as soon as they go out of scope:

use testcontainers::*;
#[test]
fn a_test() {
    let docker = clients::Cli::default();

    {
        let container = docker.run(MyImage::default());

        // Docker container is stopped/removed at the end of this scope.
    }
}

Implementations

impl<'d, D, I> Container<'d, D, I> where
    D: Docker,
    I: Image, 

pub fn new(id: String, docker_client: &'d D, image: I) -> Self

Constructs a new container given an id, a docker client and the image.

This function will block the current thread (if wait_until_ready is implemented correctly) until the container is actually ready to be used.

pub fn id(&self) -> &str

Returns the id of this container.

pub fn logs(&self) -> Logs

Gives access to the log streams of this container.

pub fn get_host_port(&self, internal_port: u16) -> Option<u16>

Returns the mapped host port for an internal port of this docker container.

This method does not magically expose the given port, it simply performs a mapping on the already exposed ports. If a docker image does not expose a port, this method will not be able to resolve it.

pub fn image(&self) -> &I

Returns a reference to the Image of this container.

Access to this is useful if the arguments of the Image change how to connect to the Access to this is useful to retrieve Image specific information such as authentication details or other relevant information which have been passed as arguments

pub fn stop(&self)

pub fn start(&self)

pub fn rm(&self)

Trait Implementations

impl<'d, D: Debug, I: Debug> Debug for Container<'d, D, I> where
    D: Docker,
    I: Image, 

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

Formats the value using the given formatter.

impl<'d, D, I> Drop for Container<'d, D, I> where
    D: Docker,
    I: Image, 

The destructor implementation for a Container.

As soon as the container goes out of scope, the destructor will either only stop or delete the docker container. This behaviour can be controlled through the KEEP_CONTAINERS environment variable. Setting it to true will only stop containers instead of removing them. Any other or no value will remove the container.

fn drop(&mut self)

Executes the destructor for this type.