Struct BashHeredoc 

pub struct BashHeredoc {
    pub tag: String,
    pub strip_tabs: bool,
    pub quoted: bool,
    pub lines: Vec<String>,
    pub fd: Option<u8>,
}

A bash heredoc block.

Fields

tag: String

The delimiter tag (e.g. “EOF”, “SCRIPT”).

strip_tabs: bool

Whether to use <<- (strip leading tabs) instead of <<.

quoted: bool

Whether to quote the tag (prevents expansion in body).

lines: Vec<String>

The heredoc body lines.

fd: Option<u8>

Target file descriptor (default 1 = stdout).

Implementations

impl BashHeredoc

pub fn new(tag: &str) -> Self

Create a new heredoc with a given delimiter tag.

pub fn strip_tabs(self) -> Self

Use <<- to strip leading tabs.

pub fn quoted(self) -> Self

Quote the delimiter (prevents variable expansion in body).

pub fn redirect_fd(self, fd: u8) -> Self

Redirect to a specific file descriptor.

pub fn line(self, s: &str) -> Self

Add a line to the heredoc body.

pub fn emit(&self) -> String

Emit the heredoc as a string.

Trait Implementations

impl Clone for BashHeredoc

fn clone(&self) -> BashHeredoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BashHeredoc

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

Formats the value using the given formatter.

impl PartialEq for BashHeredoc

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