Skip to main content

Verbosity

Enum Verbosity 

Source
pub enum Verbosity {
    Quiet,
    Normal,
    Verbose,
    VeryVerbose,
}
Expand description

User-selected verbosity for Cabin-owned status output.

The default is Verbosity::Normal, which preserves Cabin’s pre-existing status-message volume. Variants are ordered from quietest to loudest so callers can compare with >=:

if verbosity >= Verbosity::Verbose { ... }

Variants§

§

Quiet

Suppress Cabin-owned status / progress / log messages. Errors and explicitly-requested output (build artifacts, JSON documents, the user program’s stdout under cabin run) are unaffected.

§

Normal

Default volume. Status lines such as cabin: wrote build.ninja are emitted; verbose-only lines are not.

§

Verbose

Adds Cabin-owned context lines such as the resolved build profile, build directory, and toolchain summary.

§

VeryVerbose

Adds further detail intended for diagnosing local builds. Output stays deterministic and never includes secrets, tokens, or environment-dependent values that Normal / Verbose would not already print.

Implementations§

Source§

impl Verbosity

Source

pub fn as_str(self) -> &'static str

Stable string label for this variant; matches the spelling Cabin documents.

Source

pub fn shows_status(self) -> bool

Whether this verbosity emits Cabin-owned status messages.

Source

pub fn shows_verbose(self) -> bool

Whether this verbosity emits verbose-only context lines.

Source

pub fn shows_very_verbose(self) -> bool

Whether this verbosity emits very-verbose detail lines.

Source

pub fn from_verbose_count(count: u8) -> Self

Convert a -v repetition count into a verbosity. Counts of two or more clamp to Verbosity::VeryVerbose so -vvv and similar keep working without erroring.

Source

pub fn from_config_pair( verbose: Option<bool>, quiet: Option<bool>, ) -> Result<Option<Self>, InvalidVerbosityCombination>

Combine the two config booleans term.verbose and term.quiet into a single verbosity. Returns Ok(None) when neither is set so callers can fall through to the next layer in the precedence chain. Returns InvalidVerbosityCombination when both are true.

§Errors

Returns InvalidVerbosityCombination when both verbose and quiet are Some(true).

Source

pub fn parse_bool_env( variable: &'static str, raw: &str, ) -> Result<bool, VerbosityEnvError>

Parse a verbosity from a single env-var value. Used by CABIN_TERM_VERBOSE and CABIN_TERM_QUIET: a non-empty truthy value (1, true) opts in; 0, false, or empty opt out. Other strings produce a typed error so the CLI can surface a copy-pasteable message.

§Errors

Returns VerbosityEnvError when raw is non-empty and not one of 1, true, 0, or false.

Trait Implementations§

Source§

impl Clone for Verbosity

Source§

fn clone(&self) -> Verbosity

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Verbosity

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Verbosity

Source§

fn default() -> Verbosity

Returns the “default value” for a type. Read more
Source§

impl Display for Verbosity

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for Verbosity

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Verbosity

Source§

fn cmp(&self, other: &Verbosity) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Verbosity

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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.
Source§

impl PartialOrd for Verbosity

Source§

fn partial_cmp(&self, other: &Verbosity) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for Verbosity

Source§

impl Eq for Verbosity

Source§

impl StructuralPartialEq for Verbosity

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.