Struct ariadne::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 copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
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 PartialEq for Config

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Config

source§

impl Eq for Config

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

§

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

§

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

§

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.