Struct Pretty 

pub struct Pretty { /* private fields */ }

Configuration for vergen environment variable pretty printing

Build this with Pretty

Display

let mut stdout = vec![];
Pretty::builder()
    .env(vergen_pretty_env!())
    .build()
    .display(&mut stdout)?;

Trace

Generate tracing output

Pretty::builder()
    .env(vergen_pretty_env!())
    .build()
    .trace();

Output a prefix/suffix

Prefix and Suffix also have configurable styles if you enable the color feature

const TEST_PREFIX: &str = r#"A wonderful introduction
"#;
const TEST_SUFFIX: &str = r#"An outro"#;

let mut stdout = vec![];
let prefix = Prefix::builder()
    .lines(TEST_PREFIX.lines().map(str::to_string).collect())
    .build();
let suffix = Suffix::builder()
    .lines(TEST_SUFFIX.lines().map(str::to_string).collect())
    .build();
Pretty::builder()
    .env(vergen_pretty_env!())
    .prefix(prefix)
    .suffix(suffix)
    .build()
    .display(&mut stdout)?;

Customize Colorized Output

Uses Style to colorize output

let mut stdout = vec![];
let red_bold = Style::new().bold().red();
let yellow_bold = Style::new().bold().yellow();
Pretty::builder()
    .env(vergen_pretty_env!())
    .key_style(red_bold)
    .value_style(yellow_bold)
    .build()
    .display(&mut stdout)?;

Implementations

impl Pretty

pub fn trace(self)

Available on crate feature trace only.

Output the vergen environment variables that are set in table format to a tracing subscriber

impl Pretty

pub fn builder() -> PrettyBuilder

Create an instance of Pretty using the builder syntax

impl Pretty

pub fn display<T>(self, writer: &mut T) -> Result<()>

where T: Write + ?Sized,

Write the vergen environment variables that are set in table format to the given writer

Errors

• The writeln! macro can throw a std::io::Error

Trait Implementations

impl Clone for Pretty

fn clone(&self) -> Pretty

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pretty

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

Formats the value using the given formatter.

impl From<Pretty> for PrettyExt

Available on crate features rkyv or serde only.

fn from(pretty: Pretty) -> Self

Converts to this type from the input type.

impl PartialEq for Pretty

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Pretty

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Pretty