Enum Instruction

pub enum Instruction {
    From(FromInstruction),
    Arg(ArgInstruction),
    Label(LabelInstruction),
    Run(RunInstruction),
    Entrypoint(EntrypointInstruction),
    Cmd(CmdInstruction),
    Copy(CopyInstruction),
    Env(EnvInstruction),
    Misc(MiscInstruction),
}

A single Dockerfile instruction.

Individual instructions structures may be unpacked with pattern matching or via the TryFrom impls on each instruction type.

Example

use std::convert::TryInto;
use dockerfile_parser::*;

let dockerfile = Dockerfile::parse("FROM alpine:3.11").unwrap();
let from: &FromInstruction = dockerfile.instructions
  .get(0).unwrap()
  .try_into().unwrap();

assert_eq!(from.image_parsed.tag, Some("3.11".to_string()));

Variants

From(FromInstruction)

Arg(ArgInstruction)

Label(LabelInstruction)

Run(RunInstruction)

Entrypoint(EntrypointInstruction)

Cmd(CmdInstruction)

Copy(CopyInstruction)

Env(EnvInstruction)

Misc(MiscInstruction)

Implementations

impl Instruction

pub fn into_from(self) -> Option<FromInstruction>

Attempts to convert this instruction into a FromInstruction, returning None if impossible.

pub fn as_from(&self) -> Option<&FromInstruction>

Attempts to convert this instruction into a FromInstruction, returning None if impossible.

pub fn into_arg(self) -> Option<ArgInstruction>

Attempts to convert this instruction into an ArgInstruction, returning None if impossible.

pub fn as_arg(&self) -> Option<&ArgInstruction>

Attempts to convert this instruction into an ArgInstruction, returning None if impossible.

pub fn into_label(self) -> Option<LabelInstruction>

Attempts to convert this instruction into a LabelInstruction, returning None if impossible.

pub fn as_label(&self) -> Option<&LabelInstruction>

Attempts to convert this instruction into a LabelInstruction, returning None if impossible.

pub fn into_run(self) -> Option<RunInstruction>

Attempts to convert this instruction into a RunInstruction, returning None if impossible.

pub fn as_run(&self) -> Option<&RunInstruction>

Attempts to convert this instruction into a RunInstruction, returning None if impossible.

pub fn into_entrypoint(self) -> Option<EntrypointInstruction>

Attempts to convert this instruction into an EntrypointInstruction, returning None if impossible.

pub fn as_entrypoint(&self) -> Option<&EntrypointInstruction>

Attempts to convert this instruction into an EntrypointInstruction, returning None if impossible.

pub fn into_cmd(self) -> Option<CmdInstruction>

Attempts to convert this instruction into a CmdInstruction, returning None if impossible.

pub fn as_cmd(&self) -> Option<&CmdInstruction>

Attempts to convert this instruction into a CmdInstruction, returning None if impossible.

pub fn into_copy(self) -> Option<CopyInstruction>

Attempts to convert this instruction into a CopyInstruction, returning None if impossible.

pub fn as_copy(&self) -> Option<&CopyInstruction>

Attempts to convert this instruction into a CopyInstruction, returning None if impossible.

pub fn into_env(self) -> Option<EnvInstruction>

Attempts to convert this instruction into an EnvInstruction, returning None if impossible.

pub fn as_env(&self) -> Option<&EnvInstruction>

Attempts to convert this instruction into an EnvInstruction, returning None if impossible.

pub fn into_misc(self) -> Option<MiscInstruction>

Attempts to convert this instruction into a MiscInstruction, returning None if impossible.

pub fn as_misc(&self) -> Option<&MiscInstruction>

Attempts to convert this instruction into a MiscInstruction, returning None if impossible.

pub fn span(&self) -> Span

Gets the span of the instruction.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl From<ArgInstruction> for Instruction

fn from(ins: ArgInstruction) -> Self

Converts to this type from the input type.

impl From<CmdInstruction> for Instruction

fn from(ins: CmdInstruction) -> Self

Converts to this type from the input type.

impl From<CopyInstruction> for Instruction

fn from(ins: CopyInstruction) -> Self

Converts to this type from the input type.

impl From<EntrypointInstruction> for Instruction

fn from(ins: EntrypointInstruction) -> Self

Converts to this type from the input type.

impl From<EnvInstruction> for Instruction

fn from(ins: EnvInstruction) -> Self

Converts to this type from the input type.

impl From<FromInstruction> for Instruction

fn from(ins: FromInstruction) -> Self

Converts to this type from the input type.

impl From<LabelInstruction> for Instruction

fn from(ins: LabelInstruction) -> Self

Converts to this type from the input type.

impl From<MiscInstruction> for Instruction

fn from(ins: MiscInstruction) -> Self

Converts to this type from the input type.

impl From<RunInstruction> for Instruction

fn from(ins: RunInstruction) -> Self

Converts to this type from the input type.

impl PartialEq for Instruction

fn eq(&self, other: &Instruction) -> 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> TryFrom<&'a Instruction> for &'a ArgInstruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(instruction: &'a Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Instruction> for &'a CmdInstruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(instruction: &'a Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Instruction> for &'a CopyInstruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(instruction: &'a Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Instruction> for &'a EnvInstruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(instruction: &'a Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Instruction> for &'a FromInstruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(instruction: &'a Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Instruction> for &'a LabelInstruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(instruction: &'a Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Instruction> for &'a MiscInstruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(instruction: &'a Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Instruction> for &'a RunInstruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(instruction: &'a Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for EntrypointInstruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(instruction: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Pair<'_, Rule>> for Instruction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(record: Pair<'_, Rule>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Instruction

impl StructuralPartialEq for Instruction