Struct Dockerfile

pub struct Dockerfile {
    pub path: PathBuf,
    pub instructions: Vec<Instruction>,
}

This struct represents a Dockerfile instance.

Fields

path: PathBuf

instructions: Vec<Instruction>

Implementations

impl Dockerfile

pub const fn new(path: PathBuf, instructions: Vec<Instruction>) -> Self

Creates a new Dockerfile instance for the given path and instructions.

The actual file does not need to exist at this point.

pub const fn empty(path: PathBuf) -> Self

Creates an empty Dockerfile instance for the given path.

The actual file does not need to exist at this point.

pub fn from(path: PathBuf) -> ParseResult<Self>

Parses the content of the Dockerfile and returns a populated Dockerfile instance.

The file is read line by line, preserving empty lines and comments.

Example

use std::path::PathBuf;

use dockerfile_parser_rs::Dockerfile;
use dockerfile_parser_rs::ParseResult;

fn main() -> ParseResult<()> {
    let dockerfile = Dockerfile::from(PathBuf::from("./Dockerfile"))?;
    println!("{:#?}", dockerfile);
    Ok(())
}

Errors

Returns an error if the file cannot be opened or if there is a syntax error in the Dockerfile.

pub fn parse(&self) -> ParseResult<Vec<Instruction>>

Parses the content of the Dockerfile and returns a vector of Instruction items.

The file is read line by line, preserving empty lines and comments.

The attributes of the Dockerfile instance are not modified by this method.

Example

use std::path::PathBuf;

use dockerfile_parser_rs::Dockerfile;
use dockerfile_parser_rs::ParseResult;

fn main() -> ParseResult<()> {
    let dockerfile = Dockerfile::empty(PathBuf::from("./Dockerfile"));
    let instructions = dockerfile.parse()?;
    println!("{:#?}", instructions);
    Ok(())
}

Errors

Returns an error if the file cannot be opened or if there is a syntax error in the Dockerfile.

pub fn dump(&self) -> Result<()>

Dumps the current instructions into the Dockerfile.

If the file does not exist, it will be created. If the file exists, it will be overwritten.

Errors

Returns an error if the file cannot be created or written to.

pub fn steps(&self) -> usize

Returns number of instructions in the Dockerfile.

pub fn layers(&self) -> usize

Returns number of layers in the Dockerfile.

pub fn stages(&self) -> usize

Returns number of stages in the Dockerfile.

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 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 Eq for Dockerfile

impl StructuralPartialEq for Dockerfile