Enum Strip

pub enum Strip {
    None,
    Start,
    End,
    Both,
}

Controls the whitespace strip behaviour for template interpolations and directives on adjacent string literals.

The strip behaviour is controlled by a ~ immediately following an interpolation (${) or directive (%{) introduction, or preceding the closing }.

Whitespace is stripped up until (and including) the next line break:

• ${~ expr} strips whitespace from an immediately preceding string literal.
• ${expr ~} strips whitespace from an immediately following string literal.
• ${~ expr ~} strips whitespace from immediately preceding and following string literals.
• ${expr} does not strip any whitespace.

The stripping behaviour is equivalent for template directives (%{expr}).

For more details, check the section about template literals in the HCL syntax specification.

Variants

None

Don’t strip adjacent spaces.

Start

Strip any adjacent spaces from the immediately preceding string literal, if there is one.

End

Strip any adjacent spaces from the immediately following string literal, if there is one.

Both

Strip any adjacent spaces from the immediately preceding and following string literals, if there are any.

Implementations

impl Strip

pub fn strip_start(self) -> bool

Returns true if adjacent spaces should be stripped from an immediately preceding string literal.

Example

assert!(!Strip::None.strip_start());
assert!(Strip::Start.strip_start());
assert!(!Strip::End.strip_start());
assert!(Strip::Both.strip_start());

pub fn strip_end(self) -> bool

Returns true if adjacent spaces should be stripped from an immediately following string literal.

Example

assert!(!Strip::None.strip_end());
assert!(!Strip::Start.strip_end());
assert!(Strip::End.strip_end());
assert!(Strip::Both.strip_end());

Trait Implementations

impl Clone for Strip

fn clone(&self) -> Strip

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Strip

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

Formats the value using the given formatter.

impl Default for Strip

fn default() -> Strip

Returns the “default value” for a type.

impl From<(bool, bool)> for Strip

fn from(_: (bool, bool)) -> Strip

Converts to this type from the input type.

impl PartialEq for Strip

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

impl Eq for Strip

impl StructuralPartialEq for Strip