pretty

Struct BoxDoc

Source
pub struct BoxDoc<'a, A>(/* private fields */);

Methods from Deref<Target = Doc<'a, BoxDoc<'a, A>, A>>§

Source

pub fn render<'b, W>(&'b self, width: usize, out: &mut W) -> Result<()>
where T: Deref<Target = Doc<'b, T, A>>, W: ?Sized + Write,

Writes a rendered document to a std::io::Write object.

Source

pub fn render_fmt<'b, W>(&'b self, width: usize, out: &mut W) -> Result
where T: Deref<Target = Doc<'b, T, A>>, W: ?Sized + Write,

Writes a rendered document to a std::fmt::Write object.

Source

pub fn render_raw<'b, W>( &'b self, width: usize, out: &mut W, ) -> Result<(), W::Error>
where T: Deref<Target = Doc<'b, T, A>>, W: ?Sized + RenderAnnotated<A>,

Writes a rendered document to a RenderAnnotated<A> object.

Source

pub fn pretty<'b>(&'b self, width: usize) -> Pretty<'b, T, A>
where T: Deref<Target = Doc<'b, T, A>>,

Returns a value which implements std::fmt::Display

use pretty::Doc;
let doc = Doc::<_>::group(
    Doc::text("hello").append(Doc::space()).append(Doc::text("world"))
);
assert_eq!(format!("{}", doc.pretty(80)), "hello world");

Trait Implementations§

Source§

impl<'a, A: Clone> Clone for BoxDoc<'a, A>

Source§

fn clone(&self) -> BoxDoc<'a, 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, A> Debug for BoxDoc<'a, A>
where A: Debug,

Source§

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

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

impl<'a, A> Deref for BoxDoc<'a, A>

Source§

type Target = Doc<'a, BoxDoc<'a, A>, A>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<'a, A: Ord> Ord for BoxDoc<'a, A>

Source§

fn cmp(&self, other: &BoxDoc<'a, A>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<'a, A: PartialEq> PartialEq for BoxDoc<'a, A>

Source§

fn eq(&self, other: &BoxDoc<'a, A>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a, A: PartialOrd> PartialOrd for BoxDoc<'a, A>

Source§

fn partial_cmp(&self, other: &BoxDoc<'a, A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<'a, A: Eq> Eq for BoxDoc<'a, A>

Source§

impl<'a, A> StructuralPartialEq for BoxDoc<'a, A>

Auto Trait Implementations§

§

impl<'a, A> Freeze for BoxDoc<'a, A>

§

impl<'a, A> RefUnwindSafe for BoxDoc<'a, A>
where A: RefUnwindSafe,

§

impl<'a, A> Send for BoxDoc<'a, A>
where A: Send,

§

impl<'a, A> Sync for BoxDoc<'a, A>
where A: Sync,

§

impl<'a, A> Unpin for BoxDoc<'a, A>

§

impl<'a, A> UnwindSafe for BoxDoc<'a, 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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.