Struct 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<P: Display>(writer: W, prefix: P) -> 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<K: Display, V: Display>(&self, var: K, value: V)

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<K: Display, V: Debug>(&self, var: K, value: V)

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<V: ShellVars>(&self, vars: &V)

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

pub fn group<G: Display>(&self, group: G) -> Self

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

prefix_group_var=value

pub fn group_n<P: Display, N: Display>(&self, prefix: P, n: N) -> Self

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

prefix_groupN_var=value

impl ShellWriter<Stdout>

pub fn with_prefix<P: Display>(prefix: P) -> 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: Write + Debug> Debug for ShellWriter<W>

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.