15 releases

0.2.3 Jun 15, 2023
0.2.2 Jun 3, 2023
0.2.1 Feb 26, 2023
0.1.3 Apr 23, 2022

#271 in Testing

Download history 2/week @ 2024-05-21 1/week @ 2024-05-28 5/week @ 2024-06-04 5/week @ 2024-06-11 2/week @ 2024-06-18 3/week @ 2024-06-25 14/week @ 2024-07-23 3/week @ 2024-07-30

124 downloads per month
Used in 3 crates

MIT license

36KB
834 lines

contain-rs

A tool to use docker and podman containers with rust.

For usage take a look at the Documentation

Basic usage

use contain_rs::{Docker, Client, Handle, Container, Image};
use std::str::FromStr;

let podman = Docker::new();

let container = Container::from_image(Image::from_str("docker.io/library/nginx").unwrap());

let handle = podman.create(container);

handle.run();
handle.wait();

// when the handle gets out of scope the container is stopped and removed

Clients

Clients are used for scheduling containers. There are currently two implementations available. One of them works with docker the other one uses podman.

Images

Containers need image to run. You can create images like so:

use contain_rs::Image;
use std::str::FromStr;

let image = Image::from_str("docker.io/library/nginx");

assert!(image.is_ok());

let latest = Image::from_str("docker.io/library/nginx:latest");

assert!(latest.is_ok());

Macro

Contain-rs provides a derive macro to implement the IntoContainer trait for a struct. The macros feature has to be enabled to make use of the derive macro.

You can then create a container like this:

use contain_rs::*;

#[derive(ContainerImpl, Default)]
#[container(
    image = "docker.io/library/nginx",
    health_check_command = "curl http://localhost || exit 1"
)]
struct Nginx {
    #[contain_rs(port = 80)]
    port: u32,
}

let client = Docker::default();

let nginx = client.create(Nginx{ port: 8080 });

nginx.run();
nginx.wait();
nginx.rm(); // stops and removes the container
// this would be done automatically when the container handle goes out of scope

Dependencies

~3–12MB
~137K SLoC