Struct Stage

pub struct Stage<'a> {
    pub index: usize,
    pub name: Option<String>,
    pub instructions: Vec<&'a Instruction>,
    pub parent: StageParent<'a>,
    pub root: StageParent<'a>,
}

A single stage in a multi-stage build.

A stage begins with (and includes) a FROM instruction and continues until (but does not include) the next FROM instruction, if any.

Stages have an index and an optional alias. Later COPY --from=$index [...] instructions may copy files between unnamed build stages. The alias, if defined in this stage’s FROM instruction, may be used as well.

Note that instructions in a Dockerfile before the first FROM are not included in the first stage’s list of instructions.

Fields

index: usize

The stage index.

name: Option<String>

The stage’s FROM alias, if any.

instructions: Vec<&'a Instruction>

An ordered list of instructions in this stage.

parent: StageParent<'a>

The direct parent of this stage.

If this is the first stage, it will be equal to the root stage.

root: StageParent<'a>

The root image of this stage, either an external reference (possibly from a remote registry) or scratch.

Implementations

impl<'a> Stage<'a>

pub fn arg_index(&self, name: &str) -> Option<usize>

Finds the index, relative to this stage, of an ARG instruction defining the given name. Per the Dockerfile spec, only instructions following the ARG definition in a particular stage will have the value in scope, even if it was a defined globally or in a previous stage.

Trait Implementations

impl<'a> Debug for Stage<'a>

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

Formats the value using the given formatter.

impl<'a> Ord for Stage<'a>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Stage<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd for Stage<'a>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for Stage<'a>