Struct hcl::expr::Heredoc

pub struct Heredoc {
    pub delimiter: Identifier,
    pub template: String,
    pub strip: HeredocStripMode,
}

A heredoc template expression is introduced by a << sequence and defines a template via a multi-line sequence terminated by a user-chosen delimiter.

Fields

delimiter: Identifier

The delimiter identifier that denotes the heredoc start and end.

template: String

The raw template contained in the heredoc.

strip: HeredocStripMode

The heredoc strip mode.

Implementations

impl Heredoc

pub fn new<T>(delimiter: Identifier, template: T) -> Heredoc

where T: Into<String>,

Creates a new Heredoc with the provided delimiter and template body.

pub fn with_strip_mode(self, strip: HeredocStripMode) -> Heredoc

Sets the heredoc strip mode to use on the template.

Trait Implementations

impl Clone for Heredoc

fn clone(&self) -> Heredoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Heredoc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Heredoc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Format for Heredoc

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

where W: Write,

Formats a HCL structure using a formatter and writes the result to the provided writer.

fn format_vec<W>(&self, fmt: &mut Formatter<'_, W>) -> Result<Vec<u8>>

where W: Write + AsMut<Vec<u8>>,

Formats a HCL structure using a formatter and returns the result as a Vec<u8>.

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

where W: Write + AsMut<Vec<u8>>,

Formats a HCL structure using a formatter and returns the result as a String.

impl From<Heredoc> for Expression

fn from(heredoc: Heredoc) -> Self

Converts to this type from the input type.

impl From<Heredoc> for HeredocTemplate

fn from(value: Heredoc) -> Self

Converts to this type from the input type.

impl From<Heredoc> for TemplateExpr

fn from(heredoc: Heredoc) -> Self

Converts to this type from the input type.

impl From<HeredocTemplate> for Heredoc

fn from(value: HeredocTemplate) -> Self

Converts to this type from the input type.

impl<'de> IntoDeserializer<'de, Error> for Heredoc

type Deserializer = MapAccessDeserializer<HeredocAccess>

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl PartialEq for Heredoc

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Heredoc

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Heredoc

impl StructuralPartialEq for Heredoc