Struct DockerClient 

pub struct DockerClient { /* private fields */ }

Main Docker client for managing containers, images, networks, and volumes.

Implementations

impl DockerClient

pub fn new() -> Result<Self>

Create a new Docker client with default configuration.

This respects the DOCKER_HOST environment variable.

Errors

Returns an error if unable to connect to the Docker daemon.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    Ok(())
}

pub fn with_config(config: DockerClientConfig) -> Result<Self>

Create a new Docker client with custom configuration.

Errors

Returns an error if unable to connect to the Docker daemon.

Example

use docker_client::{DockerClient, DockerClientConfig};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = DockerClientConfig::new()
        .timeout(60)
        .api_version("1.43");
    let client = DockerClient::with_config(config)?;
    Ok(())
}

pub fn connect_with_unix(path: impl Into<PathBuf>) -> Result<Self>

Connect to Docker daemon using Unix socket.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::connect_with_unix("/var/run/docker.sock")?;
    Ok(())
}

pub fn connect_with_tcp(addr: impl Into<String>) -> Result<Self>

Connect to Docker daemon using TCP.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::connect_with_tcp("localhost:2375")?;
    Ok(())
}

pub async fn version(&self) -> Result<String>

Check if Docker daemon is accessible and get version info.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let version = client.version().await?;
    println!("Docker version: {}", version);
    Ok(())
}

pub async fn ping(&self) -> Result<()>

Ping the Docker daemon to check connectivity.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    client.ping().await?;
    println!("Docker daemon is accessible");
    Ok(())
}

pub async fn info(&self) -> Result<SystemInfo>

Get system information from Docker daemon.

pub fn inner(&self) -> &Docker

Access the underlying Bollard Docker client for advanced operations.

pub fn registry(&self) -> Registry<'_>

Access registry operations.

impl DockerClient

pub fn containers(&self) -> Containers<'_>

Access container operations.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let containers = client.containers().list(true).await?;
    Ok(())
}

impl DockerClient

pub fn images(&self) -> Images<'_>

Access image operations.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let images = client.images().list(false).await?;
    Ok(())
}

impl DockerClient

pub fn networks(&self) -> Networks<'_>

Access network operations.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let networks = client.networks().list().await?;
    Ok(())
}

impl DockerClient

pub fn volumes(&self) -> Volumes<'_>

Access volume operations.

Example

use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let volumes = client.volumes().list().await?;
    Ok(())
}

Trait Implementations

impl Default for DockerClient

fn default() -> Self

Returns the “default value” for a type.