Enum BuildConfig 

pub enum BuildConfig {
    Context(String),
    Config {

        context: Option<String>,
        dockerfile: Option<String>,
        dockerfile_inline: Option<String>,
        args: EnvVars,
        target: Option<String>,
        cache_from: Vec<String>,
        cache_to: Vec<String>,
        labels: Labels,
        shm_size: Option<String>,
        network: Option<String>,
        platforms: Vec<String>,
        additional_contexts: HashMap<String, String>,
        no_cache: Option<bool>,
        pull: Option<bool>,
        extra_hosts: Vec<String>,
        tags: Vec<String>,
        privileged: Option<bool>,
        ssh: Vec<String>,
        secrets: Vec<String>,
        ulimits: IndexMap<String, UlimitConfig>,
        isolation: Option<String>,
        entitlements: Vec<String>,
        provenance: Option<Value>,
        sbom: Option<bool>,
    
},
}

Compose build: directive — either a bare context path or a full build-config block.

Variants

Context(String)

Short form: a bare build context path.

Config

Long form: the full set of build options.

Fields

context: Option<String>

Build context path; defaults to the project directory . if absent.

dockerfile: Option<String>

Path to the Dockerfile relative to the context.

dockerfile_inline: Option<String>

Inline Dockerfile contents, used in place of a Dockerfile path.

args: EnvVars

Build-time arguments passed to the builder.

target: Option<String>

Target build stage to build in a multi-stage Dockerfile.

cache_from: Vec<String>

Sources to consider for build cache resolution.

cache_to: Vec<String>

Export locations for the build cache.

labels: Labels

Labels applied to the resulting image.

shm_size: Option<String>

Size of /dev/shm available to the build.

network: Option<String>

Network mode containers use during the build.

platforms: Vec<String>

Target platforms to build the image for.

additional_contexts: HashMap<String, String>

Named additional build contexts (name -> source).

no_cache: Option<bool>

Whether to build without using any cache.

pull: Option<bool>

Whether to always attempt to pull newer versions of base images.

extra_hosts: Vec<String>

Extra host:ip mappings added to the build container’s /etc/hosts.

tags: Vec<String>

Image references to tag the built image with.

privileged: Option<bool>

Whether to run the build with elevated privileges.

ssh: Vec<String>

SSH agent sockets or keys exposed to the build.

secrets: Vec<String>

Names of top-level secrets exposed to the build.

ulimits: IndexMap<String, UlimitConfig>

Resource limits applied to the build container.

isolation: Option<String>

Build isolation technology to use.

entitlements: Vec<String>

Extra privileged entitlements granted to the build.

provenance: Option<Value>

Provenance attestation setting for the build.

sbom: Option<bool>

Whether to generate an SBOM attestation for the build.

Implementations

impl BuildConfig

pub fn context(&self) -> &str

Build context path.

In the long form, context is optional per the Compose Spec (v2.22+): a build: block carrying only dockerfile_inline: has no context and defaults to the project directory ..

pub fn dockerfile(&self) -> Option<&str>

Returns the Dockerfile path, if set.

pub fn args(&self) -> EnvVars

Returns the build arguments.

pub fn target(&self) -> Option<&str>

Returns the target build stage, if set.

pub fn no_cache(&self) -> bool

Returns whether the build should ignore the cache.

pub fn pull(&self) -> bool

Returns whether the build should always pull newer base images.

pub fn shm_size(&self) -> Option<&str>

Returns the /dev/shm size for the build, if set.

pub fn extra_hosts(&self) -> &[String]

Returns the extra host:ip mappings for the build.

pub fn tags(&self) -> &[String]

Returns the image tags to apply to the built image.

pub fn cache_from(&self) -> &[String]

Returns the cache sources for the build.

pub fn dockerfile_inline(&self) -> Option<&str>

Returns the inline Dockerfile contents, if set.

pub fn cache_to(&self) -> &[String]

build.cache_to — cache export targets (image references).

pub fn ssh(&self) -> &[String]

build.ssh — SSH agent sockets/keys for the build.

pub fn secrets(&self) -> &[String]

build.secrets — names of top-level secrets exposed to the build.

pub fn additional_contexts(&self) -> Vec<(String, String)>

build.additional_contexts — named extra build contexts (name -> source).

Trait Implementations

impl Clone for BuildConfig

fn clone(&self) -> BuildConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BuildConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BuildConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.