Struct lib_ruby_parser::nodes::Heredoc

#[repr(C)]
pub struct Heredoc {
    pub parts: Vec<Node>,
    pub heredoc_body_l: Loc,
    pub heredoc_end_l: Loc,
    pub expression_l: Loc,
}

Represents a here-document literal (both with and without interpolation)

It’s similar to Dstr in terms of abstract syntax tree, but has different source maps.

Fields

parts: Vec<Node>

A list of string parts (static literals and interpolated expressions)

heredoc_body_l: Loc

Location of the here-document body

<<-HERE\n  a\n   #{42}\nHERE
~~~~~~~~~~~~~~~

heredoc_end_l: Loc

Location of the here-document end

<<-HERE\n  a\n   #{42}\nHERE
                        ~~~~

expression_l: Loc

Location of the here-document identifier

<<-HERE\n  a\n   #{42}\nHERE
~~~~~~~

Note: This is the only node (with XHeredoc) that has expression_l smaller that all other sub-locations merged. The reason for that is that it’s possible to add more code after here-document ID:

<<-HERE + "rest"
content
HERE

Trait Implementations

impl Clone for Heredoc

fn clone(&self) -> Heredoc

Returns a copy of the value.

const 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 PartialEq<Heredoc> for Heredoc

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

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

const 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 StructuralPartialEq for Heredoc