ImageBuilder

Struct ImageBuilder 

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

Builder for building Docker images with a fluent API.

Implementations§

Source§

impl<'a> ImageBuilder<'a>

Source

pub fn dockerfile(self, path: impl Into<String>) -> Self

Set the path to the Dockerfile (relative to context).

§Example
client.images()
    .build("my-app:latest")
    .dockerfile("docker/app.Dockerfile")
    .context(std::path::Path::new("."))
    .execute()
    .await?;
Source

pub fn context(self, path: impl AsRef<Path>) -> Self

Set the build context directory.

Source

pub fn build_arg(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a build argument.

§Example
client.images()
    .build("my-app:latest")
    .build_arg("RUNTIME_IMAGE", "alpine:latest")
    .build_arg("VERSION", "1.0.0")
    .execute()
    .await?;
Source

pub fn label(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a label to the image.

Source

pub fn target(self, target: impl Into<String>) -> Self

Set the target build stage (for multi-stage builds).

§Example
client.images()
    .build("my-app:latest")
    .target("production")
    .execute()
    .await?;
Source

pub fn cache_from(self, image: impl Into<String>) -> Self

Add an image to use for build cache.

Source

pub fn remove_intermediate(self, rm: bool) -> Self

Remove intermediate containers after build (default: true).

Source

pub fn pull(self, pull: bool) -> Self

Always pull the latest base image (default: false).

Source

pub async fn execute(self) -> Result<String>

Execute the build and return the image tag.

This will stream the build output via tracing.

Auto Trait Implementations§

§

impl<'a> Freeze for ImageBuilder<'a>

§

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

§

impl<'a> Send for ImageBuilder<'a>

§

impl<'a> Sync for ImageBuilder<'a>

§

impl<'a> Unpin for ImageBuilder<'a>

§

impl<'a> !UnwindSafe for ImageBuilder<'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