Struct Dockerfile

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

This struct represents a Dockerfile instance.

Fields

instructions: Vec<Instruction>

Implementations

impl Dockerfile

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

Creates a new Dockerfile instance for the given instructions.

pub const fn empty() -> Self

Creates an empty Dockerfile instance.

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 path = PathBuf::from("./Dockerfile");

    let dockerfile = Dockerfile::from(path)?;
    dockerfile.print();
    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, path: PathBuf) -> ParseResult<()>

Dumps the instructions to a file.

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 print(&self)

Writes the instructions to the standard output.

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 duplicate 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 = ParseError

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

impl StructuralPartialEq for Dockerfile