Images

Struct Images 

Source
pub struct Images<'a> { /* private fields */ }
Expand description

Image operations manager.

Implementations§

Source§

impl<'a> Images<'a>

Source

pub fn build(&self, tag: impl Into<String>) -> ImageBuilder<'a>

Create a new image builder for building images.

§Example
use lmrc_docker::DockerClient;
use std::path::Path;

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

    client.images()
        .build("my-app:latest")
        .dockerfile("Dockerfile")
        .context(Path::new("."))
        .build_arg("RUNTIME_IMAGE", "alpine:latest")
        .execute()
        .await?;

    Ok(())
}
Source

pub fn get(&self, name_or_id: impl Into<String>) -> ImageRef<'a>

Get a reference to a specific image.

Source

pub async fn list(&self, all: bool) -> Result<Vec<ImageSummary>>

List all images.

§Example
use lmrc_docker::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let images = client.images().list(true).await?;
    for image in images {
        println!("{:?}", image.repo_tags);
    }
    Ok(())
}
Source

pub async fn pull( &self, image: impl Into<String>, credentials: Option<DockerCredentials>, ) -> Result<()>

Pull an image from a registry.

§Arguments
  • image - Image name with optional tag (e.g., “nginx:latest”)
  • credentials - Optional Docker registry credentials
§Example
use lmrc_docker::DockerClient;

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

pub async fn search( &self, term: impl Into<String>, limit: Option<i64>, ) -> Result<Vec<ImageSearchResponseItem>>

Search for images in a registry.

§Example
use lmrc_docker::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    let results = client.images().search("nginx", None).await?;
    for result in results {
        println!("{}: {}", result.name.unwrap_or_default(), result.description.unwrap_or_default());
    }
    Ok(())
}
Source

pub async fn prune(&self, dangling_only: bool) -> Result<ImagePruneResponse>

Prune unused images.

§Arguments
  • dangling_only - If true, only remove dangling images (untagged)

Auto Trait Implementations§

§

impl<'a> Freeze for Images<'a>

§

impl<'a> !RefUnwindSafe for Images<'a>

§

impl<'a> Send for Images<'a>

§

impl<'a> Sync for Images<'a>

§

impl<'a> Unpin for Images<'a>

§

impl<'a> !UnwindSafe for Images<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more