Struct BuildCommand 

pub struct BuildCommand {
    pub executor: CommandExecutor,
    /* private fields */
}

Docker build command builder with fluent API

Fields

executor: CommandExecutor

Command executor for extensibility

Implementations

impl BuildCommand

pub fn new(context: impl Into<String>) -> Self

Create a new build command for the specified context

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".");

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

Add a custom host-to-IP mapping

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .add_host("myhost:192.168.1.100");

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

Set a build-time variable

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .build_arg("VERSION", "1.0.0")
    .build_arg("DEBUG", "true");

pub fn build_args_map(self, args: HashMap<String, String>) -> Self

Set multiple build-time variables

Examples

use docker_wrapper::BuildCommand;
use std::collections::HashMap;

let mut args = HashMap::new();
args.insert("VERSION".to_string(), "1.0.0".to_string());
args.insert("DEBUG".to_string(), "true".to_string());

let build_cmd = BuildCommand::new(".").build_args_map(args);

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

Add an image to consider as cache source

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .cache_from("myapp:cache");

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

Set the parent cgroup for RUN instructions

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .cgroup_parent("/docker");

pub fn compress(self) -> Self

Compress the build context using gzip

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".").compress();

pub fn cpu_period(self, period: i64) -> Self

Set CPU period limit

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .cpu_period(100000);

pub fn cpu_quota(self, quota: i64) -> Self

Set CPU quota limit

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .cpu_quota(50000);

pub fn cpu_shares(self, shares: i64) -> Self

Set CPU shares (relative weight)

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .cpu_shares(512);

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

Set CPUs in which to allow execution

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .cpuset_cpus("0-3");

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

Set MEMs in which to allow execution

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .cpuset_mems("0-1");

pub fn disable_content_trust(self) -> Self

Skip image verification

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .disable_content_trust();

pub fn file(self, dockerfile: impl Into<PathBuf>) -> Self

Set the name/path of the Dockerfile

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .file("Dockerfile.prod");

pub fn force_rm(self) -> Self

Always remove intermediate containers

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .force_rm();

pub fn iidfile(self, file: impl Into<PathBuf>) -> Self

Write the image ID to a file

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .iidfile("/tmp/image_id.txt");

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

Set container isolation technology

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .isolation("hyperv");

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

Set metadata label for the image

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .label("version", "1.0.0")
    .label("maintainer", "team@example.com");

pub fn labels(self, labels: HashMap<String, String>) -> Self

Set multiple metadata labels

Examples

use docker_wrapper::BuildCommand;
use std::collections::HashMap;

let mut labels = HashMap::new();
labels.insert("version".to_string(), "1.0.0".to_string());
labels.insert("env".to_string(), "production".to_string());

let build_cmd = BuildCommand::new(".").labels(labels);

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

Set memory limit

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .memory("1g");

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

Set memory + swap limit

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .memory_swap("2g");

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

Set networking mode for RUN instructions

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .network("host");

pub fn no_cache(self) -> Self

Do not use cache when building

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .no_cache();

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

Set platform for multi-platform builds

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .platform("linux/amd64");

pub fn pull(self) -> Self

Always attempt to pull newer base images

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .pull();

pub fn quiet(self) -> Self

Suppress build output and print image ID on success

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .quiet();

pub fn no_rm(self) -> Self

Remove intermediate containers after successful build (default: true)

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .no_rm(); // Don't remove intermediate containers

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

Add a security option

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .security_opt("seccomp=unconfined");

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

Set size of /dev/shm

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .shm_size("128m");

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

Add a name and tag for the image

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .tag("myapp:latest")
    .tag("myapp:1.0.0");

pub fn tags(self, tags: Vec<String>) -> Self

Set multiple tags for the image

Examples

use docker_wrapper::BuildCommand;

let tags = vec!["myapp:latest".to_string(), "myapp:1.0.0".to_string()];
let build_cmd = BuildCommand::new(".").tags(tags);

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

Set the target build stage

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .target("production");

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

Add a ulimit option

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .ulimit("nofile=65536:65536");

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

Add an extra privileged entitlement

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .allow("network.host");

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

Add an annotation to the image

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .annotation("org.opencontainers.image.title=MyApp");

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

Add attestation parameters

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .attest("type=provenance,mode=max");

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

Add additional build context

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .build_context("mycontext=../path");

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

Override the configured builder

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .builder("mybuilder");

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

Add cache export destination

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .cache_to("type=registry,ref=myregistry/cache");

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

Set method for evaluating build

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .call("check");

pub fn check(self) -> Self

Enable check mode (shorthand for “–call=check”)

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .check();

pub fn load(self) -> Self

Enable load mode (shorthand for “–output=type=docker”)

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .load();

pub fn metadata_file(self, file: impl Into<PathBuf>) -> Self

Write build result metadata to file

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .metadata_file("/tmp/metadata.json");

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

Do not cache specified stage

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .no_cache_filter("build-stage");

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

Set type of progress output

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .progress("plain");

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

Set provenance attestation (shorthand for “–attest=type=provenance”)

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .provenance("mode=max");

pub fn push(self) -> Self

Enable push mode (shorthand for “–output=type=registry”)

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .push();

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

Set SBOM attestation (shorthand for “–attest=type=sbom”)

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .sbom("generator=image");

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

Add secret to expose to the build

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .secret("id=mysecret,src=/local/secret");

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

Add SSH agent socket or keys to expose

Examples

use docker_wrapper::BuildCommand;

let build_cmd = BuildCommand::new(".")
    .ssh("default");

pub fn get_executor(&self) -> &CommandExecutor

Get a reference to the command executor

pub fn get_executor_mut(&mut self) -> &mut CommandExecutor

Get a mutable reference to the command executor

impl BuildCommand

pub async fn stream<F>(&self, handler: F) -> Result<StreamResult>

where F: FnMut(OutputLine) + Send + 'static,

Run the build command with streaming output

Examples

use docker_wrapper::BuildCommand;
use docker_wrapper::StreamHandler;

let result = BuildCommand::new(".")
    .tag("myapp:latest")
    .stream(StreamHandler::print())
    .await?;

Errors

Returns an error if the build fails or encounters an I/O error

Trait Implementations

impl Clone for BuildCommand

fn clone(&self) -> BuildCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BuildCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BuildCommand

fn default() -> Self

Returns the “default value” for a type.

impl DockerCommand for BuildCommand

type Output = BuildOutput

The output type this command produces

fn get_executor(&self) -> &CommandExecutor

Get the command executor for extensibility

fn get_executor_mut(&mut self) -> &mut CommandExecutor

Get mutable command executor for extensibility

fn build_command_args(&self) -> Vec<String>

Build the complete command arguments including subcommands

fn execute<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self::Output>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the command and return the typed output

fn execute_command<'life0, 'async_trait>( &'life0 self, command_args: Vec<String>, ) -> Pin<Box<dyn Future<Output = Result<CommandOutput>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Helper method to execute the command with proper error handling

fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self

Add a raw argument to the command (escape hatch)

fn args<I, S>(&mut self, args: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Add multiple raw arguments to the command (escape hatch)

fn flag(&mut self, flag: &str) -> &mut Self

Add a flag option (e.g., –detach, –rm)

fn option(&mut self, key: &str, value: &str) -> &mut Self

Add a key-value option (e.g., –name value, –env key=value)

impl StreamableCommand for BuildCommand

fn stream<'life0, 'async_trait, F>( &'life0 self, handler: F, ) -> Pin<Box<dyn Future<Output = Result<StreamResult>> + Send + 'async_trait>>

where F: FnMut(OutputLine) + Send + 'static + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

Run the command with streaming output

fn stream_channel<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(Receiver<OutputLine>, StreamResult)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Run the command with streaming output via a channel