Struct ImageBuildOptsBuilder

pub struct ImageBuildOptsBuilder { /* private fields */ }

A builder struct for ImageBuildOpts.

Implementations

impl ImageBuildOptsBuilder

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

A builder struct for ImageBuildOpts.

Parameters:

• path - Path to a build context directory

pub fn build(self) -> ImageBuildOpts

Finish building ImageBuildOpts.

impl ImageBuildOptsBuilder

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

Instead of building for a set of platforms specified using the platform option, inspect the build’s base images, and build for all of the platforms that are available. Stages that use scratch as a starting point can not be inspected, so at least one non-scratch stage must be present for detection to work usefully.

pub fn build_args<K, V>( self, build_args: impl IntoIterator<Item = (K, V)>, ) -> Self

where K: Serialize + Eq + Hash, V: Serialize,

Key-value build time variables.

pub fn cache_from<S>(self, images: impl IntoIterator<Item = S>) -> Self

where S: Into<String>,

List of images used to build cache resolution

pub fn cpu_period(self, cpu_period: isize) -> Self

Limits the CPU CFS (Completely Fair Scheduler) period.

pub fn cpu_quota(self, cpu_quota: isize) -> Self

Limits the CPU CFS (Completely Fair Scheduler) quota.

pub fn cpu_set_cpus(self, cpu_set_cpus: isize) -> Self

Set CPUs in which to allow execution. Example: 0-1, 1-3

pub fn cpu_shares(self, cpu_shares: isize) -> Self

CPU shares - relative weights

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

Path within the build context to the Dockerfile. This is ignored if remote is specified and points to an external Dockerfile.

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

Extra hosts to add to /etc/hosts.

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

Always remove intermediate containers, even upon failure.

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

Inject http proxy environment variables into container.

pub fn labels<K, V>(self, labels: impl IntoIterator<Item = (K, V)>) -> Self

where K: Serialize + Eq + Hash, V: Serialize,

Key-value pairs to set as labels on the new image.

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

Cache intermediate layers during build.

pub fn memory(self, memory: usize) -> Self

The upper limit (in bytes) on how much memory running containers can use.

pub fn memswap(self, memswap: usize) -> Self

Limits the amount of memory and swap together.

pub fn network_mode(self, network_mode: NetworkMode) -> Self

Set the networking mode for the run commands during build.

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

Do not use the cache when building the image.

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

Output configuration.

pub fn platform(self, platform: Platform) -> Self

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

Attempt to pull the image even if an older image exists locally.

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

Suppress verbose build output.

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

A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball.

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

Remove intermediate containers after a successful build.

pub fn shared_mem_size(self, shared_mem_size: usize) -> Self

Value to use when mounting an shmfs on the container’s /dev/shm directory. Default is 64MB

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

Silently ignored. Squash the resulting images layers into a single layer.

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

A name and optional tag to apply to the image in the name:tag format.

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

Target build stage

pub fn unset_env<S>(self, unset_env: impl IntoIterator<Item = S>) -> Self

where S: Into<String>,

Unset environment variables from the final image.

Trait Implementations

impl Clone for ImageBuildOptsBuilder

fn clone(&self) -> ImageBuildOptsBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageBuildOptsBuilder

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

Formats the value using the given formatter.