Struct git_status_vars::ShellWriter

pub struct ShellWriter<W: Write> { /* private fields */ }

A writer of var=value pairs.

See ShellWriter::new().

Implementations

impl<W: Write> ShellWriter<W>

pub fn new(writer: W, prefix: impl Display) -> Self

Create a new ShellWriter. The prefix will be prepended anytime a var is outputted, e.g. prefixvar=value.

Generally, you will want to use this like:

use git_status_vars::ShellWriter;
ShellWriter::default().group("group").write_var("var", "value");
// or...
let mut buffer: Vec<u8> = vec![];
ShellWriter::new(&mut buffer, "").group("group").write_var("var", "value");
assert_eq!(buffer, b"group_var=value\n");

pub fn write_var(&self, var: impl Display, value: impl Display)

Write var=value. value will be turned into a string, then quoted for safe shell insertion. var will be assumed to be a valid name for a shell variable.

pub fn write_var_debug(&self, var: impl Display, value: impl Debug)

Write var=value. value will be formatted into a string using Debug, then quoted for safe shell insertion. var will be assumed to be a valid name for a shell variable.

pub fn write_vars(&self, vars: &impl ShellVars)

Write an object with the ShellVars trait. Mostly used with Self::group() and Self::group_n().

pub fn group(&self, group: impl Display) -> ShellWriter<W>

Generate a sub-writer with this group name. Example output:

prefix_group_var=value

pub fn group_n(&self, prefix: impl Display, n: impl Display) -> ShellWriter<W>

Generate a sub-writer with this group name and number. Example output:

prefix_groupN_var=value

impl ShellWriter<Stdout>

pub fn with_prefix(prefix: String) -> Self

Create a new ShellWriter for io::stdout() and a prefix.

Trait Implementations

impl<W: Clone + Write> Clone for ShellWriter<W>

fn clone(&self) -> ShellWriter<W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W> Debug for ShellWriter<W>where
    W: Debug + Write,

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

Formats the value using the given formatter.

impl Default for ShellWriter<Stdout>

fn default() -> Self

Create a new ShellWriter for io::stdout() and no prefix.