Skip to main content

Document

Enum Document 

Source
pub enum Document<'a> {
    Nil,
    Text(Cow<'a, str>),
    Concat(Vec<Document<'a>>),
    Group(Box<Document<'a>>),
    Indent(Box<Document<'a>>),
    Line,
    SoftLine,
    SoftLineSpace,
    HardLine,
}
Expand description

Document 抽象,用于描述布局逻辑

Variants§

§

Nil

空文档

§

Text(Cow<'a, str>)

纯文本

§

Concat(Vec<Document<'a>>)

连接多个文档

§

Group(Box<Document<'a>>)

组合文档,作为换行计算的最小单位

§

Indent(Box<Document<'a>>)

增加缩进

§

Line

强制换行

§

SoftLine

软换行:如果 Group 展开则为换行,否则为空

§

SoftLineSpace

软换行(带空格):如果 Group 展开则为换行,否则为空格

§

HardLine

强制换行且会导致父级 Group 也展开

Implementations§

Source§

impl<'a> Document<'a>

Source

pub fn render(&self, config: FormatConfig) -> String

渲染 Document 为字符串

Source

pub fn text<S: Into<Cow<'a, str>>>(text: S) -> Self

创建文本文档

Source

pub fn concat(docs: Vec<Document<'a>>) -> Self

连接多个文档

Source

pub fn group(doc: Document<'a>) -> Self

创建组合文档

Source

pub fn indent(doc: Document<'a>) -> Self

创建缩进文档

Source

pub fn join<I>(docs: I, separator: Document<'a>) -> Self
where I: IntoIterator<Item = Document<'a>>,

辅助方法:将多个文档用指定分隔符连接

Trait Implementations§

Source§

impl<'a> AsDocument for Document<'a>

Source§

fn as_document(&self) -> Document<'_>

Converts this type to a document for pretty printing.
Source§

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

Source§

fn clone(&self) -> Document<'a>

Returns a duplicate 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 str> for Document<'a>

Source§

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

Converts to this type from the input type.
Source§

impl<'a> From<Cow<'a, str>> for Document<'a>

Source§

fn from(s: Cow<'a, str>) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Document<'_>

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl<'a> Serialize for Document<'a>

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<'a> ToDocument<'a> for Document<'a>

Source§

fn to_document(self) -> Document<'a>

Converts this type to a document value.

Auto Trait Implementations§

§

impl<'a> Freeze for Document<'a>

§

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

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.