Struct ZImage 

pub struct ZImage {

    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 os: Option<ImageOs>,
    pub isolation: Option<ZIsolation>,
    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>,
}

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”)

os: Option<ImageOs>

Target OS for this image/stage. Overrides any OS inferred from platform. Default: inferred or Linux.

isolation: Option<ZIsolation>

Runtime isolation hint for the output image. Friendly aliases map to the canonical zlayer_types::spec::RuntimeIsolation (see ZImage::resolve_isolation); the resolved value is stamped into image labels under com.zlayer.isolation.

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)

Implementations

impl ZImage

pub fn resolve_target_os(&self) -> Option<ImageOs>

Resolve the target OS for this image from the explicit os: field, falling back to the OS portion of platform: if present, else None.

Returns None when neither field gives a definitive answer — callers should interpret that as “default to Linux” (i.e. the historical behaviour for all existing ZImagefiles).

A malformed platform: value (one that does not parse to a known ImageOs) is ignored here on purpose: platform: has historically been a free-form string and arch-only values like "amd64" must continue to work. Callers wanting strict validation should use [ImageOs::from_str] directly.

pub fn resolve_isolation(&self) -> Option<RuntimeIsolation>

Resolve the friendly isolation: alias to the canonical zlayer_types::spec::RuntimeIsolation.

Returns None when no isolation: was declared. native is a synonym for sandbox; container resolves to vz on Darwin targets (so a Linux container runs under a VZ Linux microVM on macOS) and vz-linux otherwise.

Trait Implementations

impl Clone for ZImage

fn clone(&self) -> ZImage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZImage

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ZImage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.