Struct nu_source::DebugDoc

pub struct DebugDoc {
    pub inner: Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>,
}

Fields

inner: Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

Implementations

impl DebugDoc

pub fn new(
    inner: Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>
) -> Self

Constructs a new DebugDoc.

Methods from Deref<Target = Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>>

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

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

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

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

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

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

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

impl Clone for DebugDoc

fn clone(&self) -> DebugDoc

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DebugDoc

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

Formats the value using the given formatter.

impl Deref for DebugDoc

type Target = Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

The resulting type after dereferencing.

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

Dereferences the value.

impl From<DebugDoc> for Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

fn from(
    input: DebugDoc
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

Performs the conversion.

impl Hash for DebugDoc

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for DebugDoc

fn cmp(&self, other: &DebugDoc) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<DebugDoc> for DebugDoc

fn eq(&self, other: &DebugDoc) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<DebugDoc> for DebugDoc

fn partial_cmp(&self, other: &DebugDoc) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PrettyDebug for DebugDoc

fn pretty(&self) -> DebugDocBuilder

fn to_doc(&self) -> DebugDoc

fn pretty_doc(
    &self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

fn pretty_builder(&self) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>

fn display(&self) -> String

A convenience method that prints out the document without colors in 70 columns. Generally, you should use plain_string or colored_string if possible, but display() can be useful for trace lines and things like that, where you don’t have control over the terminal.

fn plain_string(&self, width: usize) -> String

fn colored_string(&self, width: usize) -> String

impl Eq for DebugDoc

impl StructuralEq for DebugDoc

impl StructuralPartialEq for DebugDoc