harbourmaster 0.5.0

Convenient, high-level abstractions of running Docker containers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

#![deny(clippy::all, missing_docs, missing_debug_implementations)]
#![warn(clippy::pedantic)]
#![allow(clippy::missing_errors_doc)]

//! [![Continuous integration](https://github.com/danieleades/harbourmaster/actions/workflows/CI.yml/badge.svg)](https://github.com/danieleades/harbourmaster/actions/workflows/CI.yml)
//! [![Latest Docs](https://docs.rs/harbourmaster/badge.svg)](https://docs.rs/harbourmaster/)
//!
//! Harbourmaster is a library of high-level abstractions of Docker objects.
//!
//! Harbourmaster is built on top of the excellent '[shiplift](https://github.com/softprops/shiplift)', but provides an object-oriented interface that
//! is a little easier to work with for some use cases.
//!
//! Particularly useful for unit testing that involves spinning up and then
//! removing Docker containers.
//!
//! ## Usage
//! ```no_run
//! use harbourmaster::Container;
//!
//! #[tokio::main]
//! async fn main() {
//!     let image = "alpine";
//!
//!     println!("creating container!");
//!     let container = Container::new(image).await.unwrap();
//!     println!("container created!");
//!
//!     println!("removing container!");
//!     container.delete().await.unwrap();
//!     println!("container removed!");
//! }
//! ```

mod client;
pub use client::Client;
mod container;
mod network;
pub use crate::network::Network;
mod port;
pub use crate::port::Protocol;
pub use container::{Builder as ContainerBuilder, Container};

pub use shiplift::Error;