Skip to main content

BuildRequest

Struct BuildRequest 

Source
pub struct BuildRequest {
Show 27 fields pub request_id: String, pub context_dir: String, pub dockerfile_paths: Vec<String>, pub tags: Vec<String>, pub platforms: Vec<String>, pub build_args: HashMap<String, String>, pub secrets: Vec<String>, pub ssh: Vec<String>, pub target_stage: String, pub host_network: bool, pub cache_from: String, pub cache_to: String, pub no_cache: bool, pub squash: bool, pub layers: bool, pub format: String, pub pull_policy: String, pub labels: Vec<String>, pub annotations: Vec<String>, pub add_hosts: Vec<String>, pub envs: Vec<String>, pub shm_size: String, pub ulimits: Vec<String>, pub volumes: Vec<String>, pub source_date_epoch: i64, pub rewrite_timestamp: bool, pub isolation: String,
}
Expand description

One Build request maps to one imagebuildah.BuildDockerfiles invocation on the server. Fields mirror the subset of define.BuildOptions ZLayer uses, plus enough additional knobs to cover the existing CLI surface.

Fields§

§request_id: String

Optional client-supplied request ID. Sidecar echoes back via events for correlation; if empty, sidecar mints a UUID and reports via the first event.

§context_dir: String

Absolute path to the build context directory (sidecar-visible). When the sidecar and client are on the same host this is the directory path; for remote sidecars, the client uploads via a future ContextStream RPC (not in this version of the schema).

§dockerfile_paths: Vec<String>

One or more Dockerfile paths (relative to context_dir or absolute).

§tags: Vec<String>

Image tags to apply. First tag is Output; the rest are AdditionalTags.

§platforms: Vec<String>

Target platforms (e.g. “linux/amd64”, “linux/arm64”).

§build_args: HashMap<String, String>

ARG values.

§secrets: Vec<String>

Secret specs in buildah –secret form: “id=mysecret,src=/path” or “id=mysecret,env=MY_VAR”.

§ssh: Vec<String>

SSH specs in buildah –ssh form: “default” or “=”.

§target_stage: String

Multi-stage target. Empty string means “build all stages.”

§host_network: bool

Use host networking. Maps to buildah –network=host.

§cache_from: String

Cache import / export references.

§cache_to: String§no_cache: bool

Buildah behavior toggles.

§squash: bool§layers: bool§format: String

Output format. Empty => buildah default. Allowed: “oci”, “docker”.

§pull_policy: String

Pull policy. Empty => buildah default. Allowed: “always”, “missing”, “never”, “ifnewer”.

§labels: Vec<String>

Additional labels in “key=value” form (mirrors –label).

§annotations: Vec<String>

Additional annotations in “key=value” form.

§add_hosts: Vec<String>

Hosts to add to /etc/hosts in “name:ip” form.

§envs: Vec<String>

Per-build env overrides (–env).

§shm_size: String

Shared memory size, e.g. “64m”. Empty => buildah default.

§ulimits: Vec<String>

ulimits, e.g. “nofile=1024:2048”.

§volumes: Vec<String>

Bind mounts (–volume) in “src:dst[:opts]” form.

§source_date_epoch: i64

Reproducibility knobs.

seconds; 0 means unset

§rewrite_timestamp: bool§isolation: String

Buildah isolation backend. One of: “” — sidecar picks the safe default (chroot when rootless, oci when uid 0). “default” — buildah’s default for the host (= oci on Linux). “oci” — runc/crun. “rootless” — runc-rootless. “chroot” — simple chroot, no container runtime needed.

Trait Implementations§

Source§

impl Clone for BuildRequest

Source§

fn clone(&self) -> BuildRequest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BuildRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BuildRequest

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Message for BuildRequest

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
Source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
Source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
Source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
Source§

impl PartialEq for BuildRequest

Source§

fn eq(&self, other: &BuildRequest) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for BuildRequest

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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