Struct HeredocTemplate

pub struct HeredocTemplate {
    pub delimiter: Ident,
    pub template: Template,
    /* private fields */
}

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

Fields

delimiter: Ident

The delimiter identifier that denotes the heredoc start and end.

template: Template

The raw template contained in the heredoc.

Implementations

impl HeredocTemplate

pub fn new(delimiter: Ident, template: Template) -> HeredocTemplate

Creates a new HeredocTemplate for a delimiter and a template.

pub fn indent(&self) -> Option<usize>

Return the heredoc’s indent, if there is any.

pub fn set_indent(&mut self, indent: usize)

Set the heredoc’s indent.

pub fn trailing(&self) -> &RawString

Return a reference to the raw trailing decor before the heredoc’s closing delimiter.

pub fn set_trailing(&mut self, trailing: impl Into<RawString>)

Set the raw trailing decor before the heredoc’s closing delimiter.

pub fn dedent(&mut self)

Dedent the heredoc template.

This will set the heredoc’s indent to the number of leading spaces that were stripped off of template string literals, if any.

Trait Implementations

impl Clone for HeredocTemplate

fn clone(&self) -> HeredocTemplate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeredocTemplate

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

Formats the value using the given formatter.

impl Decorate for HeredocTemplate

fn decor(&self) -> &Decor

Returns a reference to the object’s Decor.

fn decor_mut(&mut self) -> &mut Decor

Returns a mutable reference to the object’s Decor.

fn decorate(&mut self, decor: impl Into<Decor>)

Decorate the object with decor in-place.

fn decorated(self, decor: impl Into<Decor>) -> Self

where Self: Sized,

Decorate the object with decor and return the modified value.

impl From<HeredocTemplate> for Expression

fn from(value: HeredocTemplate) -> Self

Converts to this type from the input type.

impl PartialEq for HeredocTemplate

fn eq(&self, other: &Self) -> 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 Span for HeredocTemplate

fn span(&self) -> Option<Range<usize>>

Obtains the span information. This only returns Some if the value was emitted by the parser.

impl Eq for HeredocTemplate