lmrc-docker 0.3.16

Docker client library for the LMRC Stack - ergonomic fluent APIs for containers, images, networks, volumes, and registry management
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

#![allow(deprecated)]
#![allow(unused_imports)]
//! # Docker Client
//!
//! A comprehensive, ergonomic Docker client library for Rust built on top of Bollard.
//!
//! ## Features
//!
//! - **Full Docker API Coverage**: Containers, images, networks, and volumes
//! - **Fluent Builder APIs**: Ergonomic, chainable methods for creating resources
//! - **Async/Await**: Built on Tokio for modern async Rust
//! - **Type-Safe**: Leverage Rust's type system for compile-time safety
//! - **Well Documented**: Comprehensive documentation and examples
//!
//! ## Quick Start
//!
//! ```no_run
//! use lmrc_docker::DockerClient;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     // Create a client
//!     let client = DockerClient::new()?;
//!
//!     // Check Docker is available
//!     client.ping().await?;
//!
//!     // Pull an image
//!     client.images().pull("nginx:latest", None).await?;
//!
//!     // Create and start a container
//!     let container = client.containers()
//!         .create("nginx:latest")
//!         .name("web-server")
//!         .port(8080, 80, "tcp")
//!         .env("ENV", "production")
//!         .build()
//!         .await?;
//!
//!     container.start().await?;
//!
//!     // List running containers
//!     let containers = client.containers().list(false).await?;
//!     println!("Running {} containers", containers.len());
//!
//!     // Stop and remove the container
//!     container.stop(Some(10)).await?;
//!     container.remove(false, false).await?;
//!
//!     Ok(())
//! }
//! ```
//!
//! ## Modules
//!
//! - [`client`]: Docker client configuration and connection
//! - [`containers`]: Container lifecycle management
//! - [`images`]: Image operations (build, pull, push, etc.)
//! - [`networks`]: Network management
//! - [`volumes`]: Volume operations
//! - [`registry`]: Registry operations (search, authentication, image management)
//! - [`error`]: Error types and result aliases

// Re-export commonly used types from bollard
pub use bollard::auth::DockerCredentials;
pub use bollard::models::{
    ContainerInspectResponse, ContainerSummary, ImageInspect, ImageSummary, Network, Volume,
};

// Public modules
pub mod client;
pub mod containers;
pub mod error;
pub mod images;
pub mod networks;
pub mod registry;
pub mod volumes;

// Re-export main types at crate root for convenience
pub use client::{DockerClient, DockerClientConfig};
pub use containers::{ContainerBuilder, ContainerRef, Containers};
pub use error::{DockerError, Result};
pub use images::{ImageBuilder, ImageRef, Images};
pub use networks::{NetworkRef, Networks};
pub use registry::{ImageSearchResult, Registry, RegistryConfig};
pub use volumes::{VolumeRef, Volumes};