Skip to main content

Writer

Struct Writer 

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

Accumulates rendered text with an indentation level.

Implementations§

Source§

impl Writer

Source

pub fn new(unit: &'static str) -> Self

A writer indenting by unit per level.

Source

pub fn spaces4() -> Self

A writer indenting by four spaces, which is what Rust, C++ and Java conventionally use and what the previous emitters wrote.

Source

pub fn indent(&mut self)

Go one level deeper.

Source

pub fn dedent(&mut self)

Come back one level.

Source

pub const fn depth(&self) -> usize

How deep it currently is, so a caller can assert on balance.

Source

pub fn push(&mut self, text: &str)

Write text, indenting first when the line is still empty.

Source

pub fn line(&mut self, text: &str)

Write text and end the line.

Source

pub fn newline(&mut self)

End the line.

A line with nothing on it gets no indentation: trailing whitespace on a blank line is what a formatter strips and what a byte-comparison then reports as a difference.

Source

pub fn finish_line(&mut self)

End the line only if something has been written to it.

For a renderer that does not know whether the previous node left the line open.

Source

pub fn blank_line(&mut self)

An empty line, unless the output is empty or already ends in one.

Idempotent so that a renderer separating two optional sections does not have to know whether the first was there.

Source

pub fn is_empty(&self) -> bool

Whether nothing has been written.

Source

pub fn as_str(&self) -> &str

The text written so far.

Source

pub fn finish(self) -> String

The text, with the writer consumed.

Trait Implementations§

Source§

impl Clone for Writer

Source§

fn clone(&self) -> Self

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 Writer

Source§

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

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

impl Default for Writer

Source§

fn default() -> Self

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

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.