Struct Dockerfile

pub struct Dockerfile {
    pub content: String,
    pub global_args: Vec<ArgInstruction>,
    pub instructions: Vec<Instruction>,
}

A parsed Dockerfile.

An ordered list of all instructions is available via instructions, and individual stages in a multi-stage build may be iterated over using Dockerfile::iter_stages().

Example

use dockerfile_parser::Dockerfile;
use std::io::Read;

let s = r#"
  FROM alpine:3.11
  RUN echo "hello world"
"#;

assert_eq!(
  Dockerfile::parse(&s).unwrap(),
  s.parse::<Dockerfile>().unwrap()
);
assert_eq!(
  Dockerfile::parse(&s).unwrap(),
  Dockerfile::from_reader(s.as_bytes()).unwrap()
);

Fields

content: String

The raw content of the Dockerfile

global_args: Vec<ArgInstruction>

An ordered list of parsed ARG instructions preceding the first FROM

instructions: Vec<Instruction>

An ordered list of all parsed instructions, including global_args

Implementations

impl Dockerfile

pub fn parse(input: &str) -> Result<Dockerfile>

Parses a Dockerfile from a string.

pub fn from_reader<R>(reader: R) -> Result<Dockerfile>

where R: Read,

Parses a Dockerfile from a reader.

pub fn stages(&self) -> Stages<'_>

Returns a Stages, which splits this Dockerfile into its build stages.

pub fn iter_stages(&self) -> IntoIter<Stage<'_>>

pub fn splicer(&self) -> Splicer

Creates a Splicer for this Dockerfile.

Note that the original input string is needed to actually perform any splicing.

pub fn get_global_arg(&self, name: &str) -> Option<&ArgInstruction>

Attempts to find a global argument by name. Returns None if no global ARG with the given name exists.

Trait Implementations

impl Clone for Dockerfile

fn clone(&self) -> Dockerfile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dockerfile

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

Formats the value using the given formatter.

impl FromStr for Dockerfile

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Dockerfile

fn eq(&self, other: &Dockerfile) -> 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 StructuralPartialEq for Dockerfile