Struct ContainerAsync

pub struct ContainerAsync<I: Image> { /* private fields */ }

Represents a running docker container that has been started using an async client.

Containers have a custom destructor that removes them as soon as they go out of scope. However, async drop is not available in rust yet. This implementation is using block_on.

use testcontainers::*;
#[tokio::test]
async fn a_test() {
    let container = MyImage::default().start().await.unwrap();
    // Docker container is stopped/removed at the end of this scope.
}

Implementations

impl<I> ContainerAsync<I>

where I: Image,

pub fn id(&self) -> &str

Returns the id of this container.

pub fn image(&self) -> &I

Returns a reference to the Image of this container.

pub async fn ports(&self) -> Result<Ports>

pub async fn get_host_port_ipv4( &self, internal_port: impl Into<ContainerPort>, ) -> Result<u16>

Returns the mapped host port for an internal port of this docker container, on the host’s IPv4 interfaces.

By default, u16 is considered as TCP port. Also, you can convert u16 to ContainerPort port by using crate::core::IntoContainerPort trait.

This method does not magically expose the given port, it simply performs a mapping on the already exposed ports. If a docker container does not expose a port, this method will return an error.

pub async fn get_host_port_ipv6( &self, internal_port: impl Into<ContainerPort>, ) -> Result<u16>

Returns the mapped host port for an internal port of this docker container, on the host’s IPv6 interfaces.

By default, u16 is considered as TCP port. Also, you can convert u16 to ContainerPort port by using crate::core::IntoContainerPort trait.

This method does not magically expose the given port, it simply performs a mapping on the already exposed ports. If a docker container does not expose a port, this method will return an error.

pub async fn get_bridge_ip_address(&self) -> Result<IpAddr>

Returns the bridge ip address of docker container as specified in NetworkSettings.Networks.IPAddress

pub async fn get_host(&self) -> Result<Host>

Returns the host that this container may be reached on (may not be the local machine) Suitable for use in URL

pub async fn exec(&self, cmd: ExecCommand) -> Result<ExecResult>

Executes a command in the container.

pub async fn start(&self) -> Result<()>

Starts the container.

pub async fn stop(&self) -> Result<()>

Stops the container (not the same with pause).

pub async fn rm(self) -> Result<()>

Removes the container.

pub fn stdout(&self, follow: bool) -> Pin<Box<dyn AsyncBufRead + Send>>

Returns an asynchronous reader for stdout.

Accepts a boolean parameter to follow the logs:

• pass true to read logs from the moment the container starts until it stops (returns I/O error with kind UnexpectedEof if container removed).
• pass false to read logs from startup to present.

pub fn stderr(&self, follow: bool) -> Pin<Box<dyn AsyncBufRead + Send>>

Returns an asynchronous reader for stderr.

Accepts a boolean parameter to follow the logs:

• pass true to read logs from the moment the container starts until it stops (returns I/O error with UnexpectedEof if container removed).
• pass false to read logs from startup to present.

pub async fn stdout_to_vec(&self) -> Result<Vec<u8>>

Returns stdout as a vector of bytes available at the moment of call (from container startup to present).

If you want to read stdout in asynchronous manner, use ContainerAsync::stdout instead.

pub async fn stderr_to_vec(&self) -> Result<Vec<u8>>

Returns stderr as a vector of bytes available at the moment of call (from container startup to present).

If you want to read stderr in asynchronous manner, use ContainerAsync::stderr instead.

Trait Implementations

impl<I> Debug for ContainerAsync<I>

where I: Debug + Image,

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

Formats the value using the given formatter.

impl<I> Drop for ContainerAsync<I>

where I: Image,

fn drop(&mut self)

Executes the destructor for this type.