Skip to main content

ZImage

Struct ZImage 

Source
pub struct ZImage {
Show 19 fields pub version: Option<String>, pub runtime: Option<String>, pub base: Option<String>, pub build: Option<ZBuildContext>, pub steps: Vec<ZStep>, pub platform: Option<String>, pub stages: Option<IndexMap<String, ZStage>>, pub wasm: Option<ZWasmConfig>, pub env: HashMap<String, String>, pub workdir: Option<String>, pub expose: Option<ZExpose>, pub cmd: Option<ZCommand>, pub entrypoint: Option<ZCommand>, pub user: Option<String>, pub labels: HashMap<String, String>, pub volumes: Vec<String>, pub healthcheck: Option<ZHealthcheck>, pub stopsignal: Option<String>, pub args: HashMap<String, String>,
}
Expand description

Top-level ZImagefile representation.

Exactly one of the four mode fields must be set:

  • runtime for runtime template shorthand
  • base + steps for single-stage builds
  • stages for multi-stage builds
  • wasm for WebAssembly component builds

Common image metadata fields (env, workdir, expose, cmd, etc.) apply to the final output image regardless of mode.

Fields§

§version: Option<String>

ZImagefile format version (currently must be “1”)

§runtime: Option<String>

Runtime template name, e.g. “node22”, “python313”, “rust”

§base: Option<String>

Base image for single-stage builds (e.g. “alpine:3.19”). Mutually exclusive with build.

§build: Option<ZBuildContext>

Build a base image from a local Dockerfile/ZImagefile context. Mutually exclusive with base.

§steps: Vec<ZStep>

Build steps for single-stage mode

§platform: Option<String>

Target platform for single-stage mode (e.g. “linux/amd64”)

§stages: Option<IndexMap<String, ZStage>>

Named stages for multi-stage builds. Insertion order is preserved; the last stage is the output image.

§wasm: Option<ZWasmConfig>

WebAssembly build configuration

§env: HashMap<String, String>

Environment variables applied to the final image

§workdir: Option<String>

Working directory for the final image

§expose: Option<ZExpose>

Ports to expose

§cmd: Option<ZCommand>

Default command (CMD equivalent)

§entrypoint: Option<ZCommand>

Entrypoint command

§user: Option<String>

User to run as in the final image

§labels: HashMap<String, String>

Image labels / metadata

§volumes: Vec<String>

Volume mount points

§healthcheck: Option<ZHealthcheck>

Healthcheck configuration

§stopsignal: Option<String>

Signal to send when stopping the container

§args: HashMap<String, String>

Build arguments (name -> default value)

Trait Implementations§

Source§

impl Clone for ZImage

Source§

fn clone(&self) -> ZImage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ZImage

Source§

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

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

impl<'de> Deserialize<'de> for ZImage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ZImage

Source§

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

Serialize this value into the given Serde serializer. Read more

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> 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> 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,