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

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl StructuralPartialEq for Config

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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

pub fn to_owned(&self) -> T

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

source

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

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ariadne::Config

Implementations

impl Config

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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

impl Debug for Config

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

impl Default for Config

fn default() -> Self

impl PartialEq<Config> for Config

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

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

impl Copy for Config

impl Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

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