Struct Container

pub struct Container<I>
where
    I: ToRunnableContainer,
{
    pub(crate) runner: Runner,
    pub(crate) id: ContainerId,
    pub(crate) image: I,
    pub(crate) image_ref: ImageReference,
    pub(crate) detached: Arc<AtomicBool>,
}

A running container

It implements std::ops::Deref for the image.

When it’s dropped, by default it’s stopping the container, but you can choose to keep alive this container by calling Container::detach

Fields

runner: Runner

id: ContainerId

image: I

image_ref: ImageReference

detached: Arc<AtomicBool>

Implementations

impl<I> Container<I>

where I: ToRunnableContainer,

pub fn id(&self) -> ContainerId

The container id

pub fn detach(&self)

Detach the container

A detached container won’t be stopped during the drop.

impl Container<Postgres>

pub async fn config(&self) -> Result<String, PortError>

Errors

Could fail if the port is not bind

pub async fn url(&self) -> Result<String, PortError>

Get connection URL

Errors

Could fail if the port is not bind

impl Container<Minio>

pub async fn create_s3_bucket(&self, name: &str) -> Result<(), RunnerError>

Create a bucket

Errors

Could fail if we cannot create the bucket

pub async fn endpoint(&self) -> Result<String, PortError>

Get endpoint URL

Errors

Could fail if the port is not bind

pub async fn console_endpoint(&self) -> Result<String, PortError>

Get console endpoint URL

Errors

Could fail if the console port is not bind

impl Container<Redis>

pub async fn endpoint(&self) -> Result<String, PortError>

Get endpoint URL

Errors

Could fail if the port is not bind

impl Container<Mongo>

pub async fn endpoint(&self) -> Result<String, PortError>

Get endpoint URL

Errors

Could fail if the port is not bind

impl Container<Mosquitto>

pub async fn endpoint(&self) -> Result<String, PortError>

Get endpoint URL

Errors

Could fail if the port is not bind

impl Container<Nats>

pub async fn client_endpoint(&self) -> Result<String, PortError>

Get endpoint URL for the client port

Errors

Could fail if the port is not bind

pub async fn monitoring_endpoint(&self) -> Result<String, PortError>

Get endpoint URL for the monitoring port

Errors

Could fail if the port is not bind

pub async fn cluster_endpoint(&self) -> Result<String, PortError>

Get endpoint URL for the cluster port

Errors

Could fail if the port is not bind

impl Container<GenericImage>

pub async fn host_port( &self, container_port: impl Into<Port>, ) -> Result<Port, PortError>

Find the host port for a container port

Errors

Fail if there is no mapping with the container port Could fail if the port is not bind

Trait Implementations

impl<I> Debug for Container<I>

where I: Debug + ToRunnableContainer,

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

Formats the value using the given formatter.

impl<I> Deref for Container<I>

where I: ToRunnableContainer,

type Target = I

The resulting type after dereferencing.

fn deref(&self) -> &<Container<I> as Deref>::Target

Dereferences the value.

impl<I> Display for Container<I>

where I: ToRunnableContainer,

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

Formats the value using the given formatter.

impl<I> Drop for Container<I>

where I: ToRunnableContainer,

fn drop(&mut self)

Executes the destructor for this type.