Struct harbourmaster::Container

pub struct Container { /* fields omitted */ }

Abstraction of a running Docker container.

Use the new method to create a Container with sensible defaults, or the builder method if you need advanced features.

Container constructors return a future which will be resolved to a Container. The Containers will NOT clean themselves up when they are dropped, you must call the delete method on them to remove the container from the host machine.

Methods

impl Container

pub async fn new(image_name: impl Into<String>) -> Result<Container, Error>

Create a new Docker container.

Example

use harbourmaster::Container;
use tokio;

   let future03 = async {
       let image = "alpine";

       let container = Container::new(image).await.unwrap();
       println!("container created!");

       container.delete().await.unwrap();
       println!("container deleted!");

       Ok(())
   };

   // For the time being, we have to convert the future from a future-0.3 to a future-0.1 to run on the tokio executor
   use futures::future::{FutureExt, TryFutureExt};
   let future01 = future03.boxed().compat();

   tokio::run(future01);

pub fn builder(image_name: impl Into<String>) -> ContainerBuilder

Create a new Docker container with advanced configuration.

Check the ContainerBuilder documentation for the full list of options.

Example

use harbourmaster::{Container, Protocol};
use tokio;

    let future03 = async {
        let container = Container::builder("couchdb")
            // the docker image tag to use
            .tag("2.3.0")

            // set the name of the docker container
            .name("test_container")

            // optionally add an alphanumeric 'slug' to the
            // container name. Useful if you're creating and
            // naming them in bulk
            .slug_length(6)

            // expose ports on the container to the host machine
            .expose(5984, 5984, Protocol::Tcp)

            // if true, pull the image from the webular information
            // super-highway before building.
            .pull_on_build(true)

            // build the container using the above parameters
            .build()
            .await
            .unwrap();

        println!("container created!");

        container.delete().await.unwrap();
        println!("container deleted!");

        Ok(())
    };

    // For the time being, we have to convert the future from a future-0.3 to a future-0.1 to run on the tokio executor
    use futures::future::{FutureExt, TryFutureExt};
    let future01 = future03.boxed().compat();

    tokio::run(future01);

pub fn id(&self) -> &str

Return the Docker id of the running container

pub fn ports(&self) -> &HashMap<(u16, Protocol), Vec<SocketAddrV4>>

Not yet implemented

pub fn ports_raw(
    &self
) -> &Option<HashMap<String, Option<Vec<HashMap<String, String>>>>>

Exposes the underlying representation of the Docker container's ports. It's messy, this part of the API will change shortly.

pub async fn delete(self) -> Result<(), Error>

Delete the running docker container.

This is equivalent to calling docker rm -f [container].