Pretty

Struct Pretty

pub struct Pretty { /* private fields */ }

Expand description

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. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Pretty

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

Formats the value using the given formatter. Read more

impl From<Pretty> for PrettyExt

Available on crate features bincode 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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 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. Read more

impl StructuralPartialEq for Pretty

Auto Trait Implementations§

impl Freeze for Pretty

impl RefUnwindSafe for Pretty

impl Send for Pretty

impl Sync for Pretty

impl Unpin for Pretty

impl UnwindSafe for Pretty

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more