Enum mfmt::Document

source ·
pub enum Document<'a> {
    Break {
        broken: bool,
        document: &'a Document<'a>,
    },
    Indent(&'a Document<'a>),
    Line,
    LineSuffix(&'a str),
    Offside {
        document: &'a Document<'a>,
        soft: bool,
    },
    Sequence(&'a [Document<'a>]),
    String(&'a str),
}
Expand description

A document.

Variants§

§

Break

Fields

§broken: bool
§document: &'a Document<'a>

A document broken into multiple lines.

§

Indent(&'a Document<'a>)

An indented document.

§

Line

A line.

A formatter considers it as a space if a document is not broken by Break.

§

LineSuffix(&'a str)

A line suffix.

§

Offside

Fields

§document: &'a Document<'a>
§soft: bool

A document indented to a current column.

If it is soft, an indent becomes equal to or more than a current indent.

§

Sequence(&'a [Document<'a>])

A sequence of documents.

§

String(&'a str)

A string.

Trait Implementations§

source§

impl<'a> Clone for Document<'a>

source§

fn clone(&self) -> Document<'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 for Document<'a>

source§

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

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

impl<'a> From<&'a [Document<'a>]> for Document<'a>

source§

fn from(documents: &'a [Self]) -> Self

Converts to this type from the input type.
source§

impl<'a> From<&'a str> for Document<'a>

source§

fn from(string: &'a str) -> Self

Converts to this type from the input type.
source§

impl<'a> PartialEq for Document<'a>

source§

fn eq(&self, other: &Document<'a>) -> 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<'a> StructuralPartialEq for Document<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for Document<'a>

§

impl<'a> Send for Document<'a>

§

impl<'a> Sync for Document<'a>

§

impl<'a> Unpin for Document<'a>

§

impl<'a> UnwindSafe for Document<'a>

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.