Struct dockerfile_parser::BreakableString

pub struct BreakableString {
    pub span: Span,
    pub components: Vec<BreakableStringComponent>,
}

A Docker string that may be broken across several lines, separated by line continuations (\\\n), and possibly intermixed with comments.

These strings have several potentially valid interpretations. As these line continuations match those natively supported by bash, a given multiline RUN block can be pasted into a bash shell unaltered and with line continuations included. However, at "runtime" line continuations and comments (*) are stripped from the string handed to the shell.

To ensure output is correct in all cases, BreakableString preserves the user's original AST, including comments, and implements Docker's continuation-stripping behavior in the Display implementation.

Fields

span: Span

components: Vec<BreakableStringComponent>

Implementations

impl BreakableString

pub fn new(span: impl Into<Span>) -> Self

pub fn add(self, c: impl Into<BreakableStringComponent>) -> Self

pub fn add_string(self, s: impl Into<Span>, c: impl Into<String>) -> Self

pub fn add_comment(self, s: impl Into<Span>, c: impl Into<String>) -> Self

pub fn iter_components(&self) -> impl Iterator<Item = &BreakableStringComponent>

Trait Implementations

impl Clone for BreakableString

fn clone(&self) -> BreakableString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BreakableString

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

Formats the value using the given formatter.

impl Display for BreakableString

Formats this breakable string as it will be interpreted by the underlying Docker engine, i.e. on a single line with line continuations removed

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

Formats the value using the given formatter.

impl Eq for BreakableString

impl<'_> From<((usize, usize), &'_ str)> for BreakableString

fn from(s: ((usize, usize), &str)) -> Self

Performs the conversion.

impl Ord for BreakableString

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<BreakableString> for BreakableString

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<BreakableString> for BreakableString

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for BreakableString

impl StructuralPartialEq for BreakableString