Struct BuildahCommand 

pub struct BuildahCommand {
    pub program: String,
    pub args: Vec<String>,
    pub env: HashMap<String, String>,
}

A buildah command ready for execution

Fields

program: String

The program to execute (typically “buildah”)

args: Vec<String>

Command arguments

env: HashMap<String, String>

Optional environment variables for the command

Implementations

impl BuildahCommand

pub fn new(subcommand: &str) -> Self

Create a new buildah command

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

Add an argument

pub fn args(self, args: impl IntoIterator<Item = impl Into<String>>) -> Self

Add multiple arguments

pub fn arg_opt(self, flag: &str, value: Option<impl Into<String>>) -> Self

Add an optional argument (only added if value is Some)

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

Add an environment variable for command execution

pub fn to_command_string(&self) -> String

Convert to a command line string for display/logging

pub fn from_image(image: &str) -> Self

Create a new working container from an image

buildah from <image>

pub fn from_image_named(image: &str, name: &str) -> Self

Create a new working container from an image with a specific name

buildah from --name <name> <image>

pub fn from_scratch() -> Self

Create a scratch container

buildah from scratch

pub fn rm(container: &str) -> Self

Remove a working container

buildah rm <container>

pub fn commit(container: &str, image_name: &str) -> Self

Commit a container to create an image

buildah commit <container> <image>

pub fn commit_with_opts( container: &str, image_name: &str, format: Option<&str>, squash: bool, ) -> Self

Commit with additional options

pub fn tag(image: &str, new_name: &str) -> Self

Tag an image with a new name

buildah tag <image> <new-name>

pub fn rmi(image: &str) -> Self

Remove an image

buildah rmi <image>

pub fn push(image: &str) -> Self

Push an image to a registry

buildah push <image>

pub fn push_to(image: &str, destination: &str) -> Self

Push an image to a registry with options

buildah push [options] <image> [destination]

pub fn inspect(name: &str) -> Self

Inspect an image or container

buildah inspect <name>

pub fn inspect_format(name: &str, format: &str) -> Self

Inspect an image or container with format

buildah inspect --format <format> <name>

pub fn images() -> Self

List images

buildah images

pub fn containers() -> Self

List containers

buildah containers

pub fn run_shell(container: &str, command: &str) -> Self

Run a command in the container (shell form)

buildah run <container> -- /bin/sh -c "<command>"

pub fn run_exec(container: &str, args: &[String]) -> Self

Run a command in the container (exec form)

buildah run <container> -- <args...>

pub fn run(container: &str, command: &ShellOrExec) -> Self

Run a command based on ShellOrExec

pub fn run_with_mounts(container: &str, run: &RunInstruction) -> Self

Run a command with mount specifications from a RunInstruction.

Buildah requires --mount arguments to appear BEFORE the container ID: buildah run [--mount=...] <container> -- <command>

This method properly orders the arguments to ensure mounts are applied.

pub fn copy(container: &str, sources: &[String], dest: &str) -> Self

Copy files into the container

buildah copy <container> <src...> <dest>

pub fn copy_from( container: &str, from: &str, sources: &[String], dest: &str, ) -> Self

Copy files from another container/image

buildah copy --from=<source> <container> <src...> <dest>

pub fn copy_instruction(container: &str, copy: &CopyInstruction) -> Self

Copy with all options from CopyInstruction

pub fn add(container: &str, sources: &[String], dest: &str) -> Self

Add files (like copy but with URL support and extraction)

pub fn add_instruction(container: &str, add: &AddInstruction) -> Self

Add with all options from AddInstruction

pub fn config_env(container: &str, key: &str, value: &str) -> Self

Set an environment variable

buildah config --env KEY=VALUE <container>

pub fn config_envs(container: &str, env: &EnvInstruction) -> Vec<Self>

Set multiple environment variables

pub fn config_workdir(container: &str, dir: &str) -> Self

Set the working directory

buildah config --workingdir <dir> <container>

pub fn config_expose(container: &str, expose: &ExposeInstruction) -> Self

Expose a port

buildah config --port <port>/<proto> <container>

pub fn config_entrypoint_shell(container: &str, command: &str) -> Self

Set the entrypoint (shell form)

buildah config --entrypoint '<command>' <container>

pub fn config_entrypoint_exec(container: &str, args: &[String]) -> Self

Set the entrypoint (exec form)

buildah config --entrypoint '["exe", "arg1"]' <container>

pub fn config_entrypoint(container: &str, command: &ShellOrExec) -> Self

Set the entrypoint based on ShellOrExec

pub fn config_cmd_shell(container: &str, command: &str) -> Self

Set the default command (shell form)

pub fn config_cmd_exec(container: &str, args: &[String]) -> Self

Set the default command (exec form)

pub fn config_cmd(container: &str, command: &ShellOrExec) -> Self

Set the default command based on ShellOrExec

pub fn config_user(container: &str, user: &str) -> Self

Set the user

buildah config --user <user> <container>

pub fn config_label(container: &str, key: &str, value: &str) -> Self

Set a label

buildah config --label KEY=VALUE <container>

pub fn config_labels( container: &str, labels: &HashMap<String, String>, ) -> Vec<Self>

Set multiple labels

pub fn config_volume(container: &str, path: &str) -> Self

Set volumes

buildah config --volume <path> <container>

pub fn config_stopsignal(container: &str, signal: &str) -> Self

Set the stop signal

buildah config --stop-signal <signal> <container>

pub fn config_shell(container: &str, shell: &[String]) -> Self

Set the shell

buildah config --shell '["shell", "args"]' <container>

pub fn config_healthcheck( container: &str, healthcheck: &HealthcheckInstruction, ) -> Self

Set healthcheck

pub fn manifest_create(name: &str) -> Self

Create a new manifest list.

buildah manifest create <name>

pub fn manifest_add(list: &str, image: &str) -> Self

Add an image to a manifest list.

buildah manifest add <list> <image>

pub fn manifest_push(list: &str, destination: &str) -> Self

Push a manifest list and all referenced images.

buildah manifest push --all <list> <destination>

pub fn manifest_rm(list: &str) -> Self

Remove a manifest list.

buildah manifest rm <list>

pub fn from_instruction(container: &str, instruction: &Instruction) -> Vec<Self>

Convert a Dockerfile instruction to buildah command(s)

Some instructions map to multiple buildah commands (e.g., multiple ENV vars)

Trait Implementations

impl Clone for BuildahCommand

fn clone(&self) -> BuildahCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildahCommand

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

Formats the value using the given formatter.