Struct ScopedContext

pub struct ScopedContext<'a, Err: ErrorAccumulator> {
    errors: &'a Err,
    options: &'a OutputOptions,
    extensions: &'a SimpleExtensions,
    indent: IndentStack<'a>,
}

Fields

errors: &'a Err

options: &'a OutputOptions

extensions: &'a SimpleExtensions

indent: IndentStack<'a>

Implementations

impl<'a, Err: ErrorAccumulator> ScopedContext<'a, Err>

pub fn new( options: &'a OutputOptions, errors: &'a Err, extensions: &'a SimpleExtensions, ) -> Self

Trait Implementations

impl<'a, Err: Clone + ErrorAccumulator> Clone for ScopedContext<'a, Err>

fn clone(&self) -> ScopedContext<'a, Err>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Err: Debug + ErrorAccumulator> Debug for ScopedContext<'a, Err>

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

Formats the value using the given formatter.

impl<'a, Err: ErrorAccumulator> Scope for ScopedContext<'a, Err>

type Errors = Err

The type of errors that can occur when textifying a plan.

type Indent = IndentStack<'a>

fn indent(&self) -> impl Display

Get the current indent level.

fn push_indent(&self) -> Self

Push a new indent level.

fn options(&self) -> &OutputOptions

Get the options for formatting the plan.

fn errors(&self) -> &Self::Errors

fn extensions(&self) -> &SimpleExtensions

fn push_error(&self, e: FormatError)

fn failure<E: Into<FormatError>>(&self, e: E) -> ErrorToken

Handle a failure to textify a value. Textify errors are written as “!{name}” to the output (where “name” is the type name), and the error is pushed to the error accumulator.

fn expect<'a, T: Textify>( &'a self, t: Option<&'a T>, ) -> MaybeToken<impl Display>

fn expect_ok<'a, T: Textify, E: Into<FormatError>>( &'a self, result: Result<&'a T, E>, ) -> MaybeToken<impl Display + 'a>

fn display<'a, T: Textify>(&'a self, value: &'a T) -> Displayable<'a, Self, T>

fn separated<'a, T: Textify, I: IntoIterator<Item = &'a T> + Clone>( &'a self, items: I, separator: &'static str, ) -> Separated<'a, Self, T, I>

Wrap an iterator over textifiable items into a displayable that will separate them with the given separator.

fn option<'a, T: Textify>( &'a self, value: Option<&'a T>, ) -> OptionalDisplayable<'a, Self, T>

fn optional<'a, T: Textify>( &'a self, value: &'a T, option: bool, ) -> OptionalDisplayable<'a, Self, T>

impl<'a, Err: Copy + ErrorAccumulator> Copy for ScopedContext<'a, Err>