Struct pretty::DocBuilder [−][src]
pub struct DocBuilder<'a, D, A = ()>(pub &'a D, pub BuildDoc<'a, D::Doc, A>)
where
D: ?Sized + DocAllocator<'a, A>;
Expand description
The DocBuilder
type allows for convenient appending of documents even for arena allocated
documents by storing the arena inline.
Tuple Fields
0: &'a D
1: BuildDoc<'a, D::Doc, A>
Implementations
Append the given document after this document.
Acts as self
when laid out on multiple lines and acts as that
when laid out on a single line.
use pretty::{Arena, DocAllocator};
let arena = Arena::<()>::new();
let body = arena.line().append("x");
let doc = arena.text("let")
.append(arena.line())
.append("x")
.group()
.append(
body.clone()
.flat_alt(
arena.line()
.append("in")
.append(body)
)
)
.group();
assert_eq!(doc.1.pretty(100).to_string(), "let x in x");
assert_eq!(doc.1.pretty(8).to_string(), "let x\nx");
Mark this document as a group.
Groups are layed out on a single line if possible. Within a group, all basic documents with several possible layouts are assigned the same layout, that is, they are all layed out horizontally and combined into a one single line, or they are each layed out on their own line.
Increase the indentation level of this document.
pub fn union<E>(self, other: E) -> DocBuilder<'a, D, A> where
E: Into<BuildDoc<'a, D::Doc, A>>,
Lays out self
so with the nesting level set to the current column
NOTE: The doc pointer type, D
may need to be cloned. Consider using cheaply cloneable ptr
like RefDoc
or RcDoc
use pretty::DocAllocator;
let arena = pretty::Arena::<()>::new();
let doc = arena.text("lorem").append(arena.text(" "))
.append(arena.intersperse(["ipsum", "dolor"].iter().cloned(), arena.line_()).align());
assert_eq!(doc.1.pretty(80).to_string(), "lorem ipsum\n dolor");
Lays out self
with a nesting level set to the current level plus adjust
.
NOTE: The doc pointer type, D
may need to be cloned. Consider using cheaply cloneable ptr
like RefDoc
or RcDoc
use pretty::DocAllocator;
let arena = pretty::Arena::<()>::new();
let doc = arena.text("prefix").append(arena.text(" "))
.append(arena.reflow("Indenting these words with nest").hang(4));
assert_eq!(
doc.1.pretty(24).to_string(),
"prefix Indenting these\n words with\n nest",
);
Indents self
by adjust
spaces from the current cursor position
NOTE: The doc pointer type, D
may need to be cloned. Consider using cheaply cloneable ptr
like RefDoc
or RcDoc
use pretty::DocAllocator;
let arena = pretty::Arena::<()>::new();
let doc = arena.text("prefix").append(arena.text(" "))
.append(arena.reflow("The indent function indents these words!").indent(4));
assert_eq!(
doc.1.pretty(24).to_string(),
"
prefix The indent
function
indents these
words!".trim_start(),
);
Lays out self
and provides the column width of it available to f
NOTE: The doc pointer type, D
may need to be cloned. Consider using cheaply cloneable ptr
like RefDoc
or RcDoc
use pretty::DocAllocator;
let arena = pretty::Arena::<()>::new();
let doc = arena.text("prefix ")
.append(arena.column(|l| {
arena.text("| <- column ").append(arena.as_string(l)).into_doc()
}));
assert_eq!(doc.1.pretty(80).to_string(), "prefix | <- column 7");
pub fn enclose<E, F>(self, before: E, after: F) -> DocBuilder<'a, D, A> where
E: Pretty<'a, D, A>,
F: Pretty<'a, D, A>,
pub fn enclose<E, F>(self, before: E, after: F) -> DocBuilder<'a, D, A> where
E: Pretty<'a, D, A>,
F: Pretty<'a, D, A>,
Puts self
between before
and after
Methods from Deref<Target = Doc<'a, D::Doc, A>>
Writes a rendered document to a std::io::Write
object.
Writes a rendered document to a std::fmt::Write
object.
pub fn render_raw<W>(&self, width: usize, out: &mut W) -> Result<(), W::Error> where
for<'b> W: RenderAnnotated<'b, A>,
W: ?Sized,
pub fn render_raw<W>(&self, width: usize, out: &mut W) -> Result<(), W::Error> where
for<'b> W: RenderAnnotated<'b, A>,
W: ?Sized,
Writes a rendered document to a RenderAnnotated<A>
object.
Returns a value which implements std::fmt::Display
use pretty::{Doc, BoxDoc};
let doc = BoxDoc::<()>::group(
BoxDoc::text("hello").append(Doc::line()).append(Doc::text("world"))
);
assert_eq!(format!("{}", doc.pretty(80)), "hello world");
Trait Implementations
impl<'a, D, A, P> Add<P> for DocBuilder<'a, D, A> where
D: ?Sized + DocAllocator<'a, A>,
P: Pretty<'a, D, A>,
impl<'a, D, A, P> Add<P> for DocBuilder<'a, D, A> where
D: ?Sized + DocAllocator<'a, A>,
P: Pretty<'a, D, A>,
impl<'a, D, A, P> AddAssign<P> for DocBuilder<'a, D, A> where
D: ?Sized + DocAllocator<'a, A>,
P: Pretty<'a, D, A>,
impl<'a, D, A, P> AddAssign<P> for DocBuilder<'a, D, A> where
D: ?Sized + DocAllocator<'a, A>,
P: Pretty<'a, D, A>,
Performs the +=
operation. Read more
impl<'a, A, D> Clone for DocBuilder<'a, D, A> where
A: Clone,
D: DocAllocator<'a, A> + 'a,
D::Doc: Clone,
impl<'a, A, D> Clone for DocBuilder<'a, D, A> where
A: Clone,
D: DocAllocator<'a, A> + 'a,
D::Doc: Clone,
impl<'a, D, A> Debug for DocBuilder<'a, D, A> where
D: ?Sized + DocAllocator<'a, A>,
D::Doc: Debug,
A: Debug,
impl<'a, D, A> Debug for DocBuilder<'a, D, A> where
D: ?Sized + DocAllocator<'a, A>,
D::Doc: Debug,
A: Debug,
impl<'a, D, A> Into<BuildDoc<'a, <D as DocAllocator<'a, A>>::Doc, A>> for DocBuilder<'a, D, A> where
D: ?Sized + DocAllocator<'a, A>,
impl<'a, D, A> Into<BuildDoc<'a, <D as DocAllocator<'a, A>>::Doc, A>> for DocBuilder<'a, D, A> where
D: ?Sized + DocAllocator<'a, A>,
impl<'a, D, A> Pretty<'a, D, A> for DocBuilder<'a, D, A> where
A: 'a,
D: ?Sized + DocAllocator<'a, A>,
impl<'a, D, A> Pretty<'a, D, A> for DocBuilder<'a, D, A> where
A: 'a,
D: ?Sized + DocAllocator<'a, A>,
Converts self
into a document
Auto Trait Implementations
impl<'a, D: ?Sized, A> RefUnwindSafe for DocBuilder<'a, D, A> where
A: RefUnwindSafe,
D: RefUnwindSafe,
<<D as DocAllocator<'a, A>>::Doc as DocPtr<'a, A>>::ColumnFn: RefUnwindSafe,
<D as DocAllocator<'a, A>>::Doc: RefUnwindSafe,
impl<'a, D: ?Sized, A> Send for DocBuilder<'a, D, A> where
A: Send,
D: Sync,
<<D as DocAllocator<'a, A>>::Doc as DocPtr<'a, A>>::ColumnFn: Send,
<D as DocAllocator<'a, A>>::Doc: Send,
impl<'a, D: ?Sized, A> Sync for DocBuilder<'a, D, A> where
A: Sync,
D: Sync,
<<D as DocAllocator<'a, A>>::Doc as DocPtr<'a, A>>::ColumnFn: Sync,
<D as DocAllocator<'a, A>>::Doc: Sync,
impl<'a, D: ?Sized, A> Unpin for DocBuilder<'a, D, A> where
A: Unpin,
<<D as DocAllocator<'a, A>>::Doc as DocPtr<'a, A>>::ColumnFn: Unpin,
<D as DocAllocator<'a, A>>::Doc: Unpin,
impl<'a, D: ?Sized, A> UnwindSafe for DocBuilder<'a, D, A> where
A: UnwindSafe,
D: RefUnwindSafe,
<<D as DocAllocator<'a, A>>::Doc as DocPtr<'a, A>>::ColumnFn: UnwindSafe,
<D as DocAllocator<'a, A>>::Doc: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more