Skip to main content

Config

Struct Config 

Source
pub struct Config { /* private fields */ }
Expand description

A type used to configure a report

Implementations§

Source§

impl Config

Source

pub fn with_cross_gap(self, cross_gap: bool) -> Self

When label lines cross one-another, should there be a gap?

The alternative to this is to insert crossing characters. However, these interact poorly with label colours.

If unspecified, this defaults to false.

Source

pub fn with_label_attach(self, label_attach: LabelAttach) -> Self

Where should inline labels attach to their spans?

If unspecified, this defaults to LabelAttach::Middle.

Source

pub fn with_compact(self, compact: bool) -> Self

Should the report remove gaps to minimise used space?

If unspecified, this defaults to false.

Source

pub fn with_underlines(self, underlines: bool) -> Self

Should underlines be used for label span where possible?

If unspecified, this defaults to true.

Source

pub fn with_multiline_arrows(self, multiline_arrows: bool) -> Self

Should arrows be used to point to the bounds of multi-line spans?

If unspecified, this defaults to true.

Source

pub fn with_color(self, color: bool) -> Self

Should colored output should be enabled?

If unspecified, this defaults to true.

Source

pub fn with_tab_width(self, tab_width: usize) -> Self

How many characters width should tab characters be?

If unspecified, this defaults to 4.

Source

pub fn with_char_set(self, char_set: CharSet) -> Self

What character set should be used to display dynamic elements such as boxes and arrows?

If unspecified, this defaults to CharSet::Unicode.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Copy for Config

Source§

impl Debug for Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Self

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

impl Eq for Config

Source§

impl PartialEq for Config

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Config

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<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> 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, 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.