Struct mfmt::Builder

source ·
pub struct Builder<A: Allocator> { /* private fields */ }
Expand description

Document builder.

Implementations§

source§

impl<'a, A: Allocator + Clone + 'a> Builder<A>

source

pub fn new(allocator: A) -> Self

Creates a document builder.

source

pub fn allocator(&self) -> &A

Returns an allocator.

source

pub fn break(&self, value: impl Into<Document<'a>>) -> Document<'a>

Breaks a document into multiple lines.

source

pub fn flatten(&self, value: impl Into<Document<'a>>) -> Document<'a>

Flattens a document.

source

pub fn indent(&self, value: impl Into<Document<'a>>) -> Document<'a>

Indents a document by a level.

source

pub fn offside( &self, value: impl Into<Document<'a>>, soft: bool ) -> Document<'a>

Creates a document indented to a current column.

source

pub fn sequence( &self, values: impl IntoIterator<Item = impl Into<Document<'a>>> ) -> Document<'a>

Creates a sequence of documents.

source

pub fn strings<'b>( &self, values: impl IntoIterator<Item = &'b str> ) -> Document<'a>

Creates a concatenation of strings.

source

pub fn line_suffixes<'b>( &self, values: impl IntoIterator<Item = &'b str> ) -> Document<'a>

Creates a set of line suffixes.

source

pub fn allocate<T>(&self, value: T) -> &'a T

Allocates a value.

source

pub fn allocate_slice<T>(&self, values: impl IntoIterator<Item = T>) -> &'a [T]

Allocates a slice.

source

pub fn allocate_str<'b>( &self, values: impl IntoIterator<Item = &'b str> ) -> &'a str

Allocates a string.

Trait Implementations§

source§

impl<A: Clone + Allocator> Clone for Builder<A>

source§

fn clone(&self) -> Builder<A>

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<A: Debug + Allocator> Debug for Builder<A>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<A> RefUnwindSafe for Builder<A>
where A: RefUnwindSafe,

§

impl<A> Send for Builder<A>
where A: Send,

§

impl<A> Sync for Builder<A>
where A: Sync,

§

impl<A> Unpin for Builder<A>
where A: Unpin,

§

impl<A> UnwindSafe for Builder<A>
where A: UnwindSafe,

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.