Struct nu_source::DebugDocBuilder

pub struct DebugDocBuilder {
    pub inner: DocBuilder<'static, BoxAllocator, ShellAnnotation>,
}

Fields

inner: DocBuilder<'static, BoxAllocator, ShellAnnotation>

Methods

impl DebugDocBuilder

pub fn new(inner: DocBuilder<'static, BoxAllocator, ShellAnnotation>) -> Self

Constructs a new DebugDocBuilder.

impl DebugDocBuilder

pub fn from_doc(doc: DebugDoc) -> DebugDocBuilder

pub fn blank() -> DebugDocBuilder

pub fn delimiter(string: impl Display) -> DebugDocBuilder

pub fn key(string: impl Display) -> DebugDocBuilder

pub fn value(string: impl Display) -> DebugDocBuilder

pub fn as_value(self) -> DebugDocBuilder

pub fn equals() -> DebugDocBuilder

pub fn kind(string: impl Display) -> DebugDocBuilder

pub fn as_kind(self) -> DebugDocBuilder

pub fn typed(kind: &str, value: DebugDocBuilder) -> DebugDocBuilder

pub fn subtyped(
    kind: &str,
    subkind: impl Display,
    value: DebugDocBuilder
) -> DebugDocBuilder

pub fn keyword(string: impl Display) -> DebugDocBuilder

pub fn var(string: impl Display) -> DebugDocBuilder

pub fn operator(string: impl Display) -> DebugDocBuilder

pub fn primitive(string: impl Display) -> DebugDocBuilder

pub fn opaque(string: impl Display) -> DebugDocBuilder

pub fn description(string: impl Display) -> DebugDocBuilder

pub fn error(string: impl Display) -> DebugDocBuilder

pub fn delimit(start: &str, doc: DebugDocBuilder, end: &str) -> DebugDocBuilder

pub fn preceded(
    before: DebugDocBuilder,
    body: DebugDocBuilder
) -> DebugDocBuilder

pub fn surrounded_option(
    before: Option<DebugDocBuilder>,
    builder: Option<DebugDocBuilder>,
    after: Option<DebugDocBuilder>
) -> DebugDocBuilder

pub fn preceded_option(
    before: Option<DebugDocBuilder>,
    builder: Option<DebugDocBuilder>
) -> DebugDocBuilder

pub fn option(builder: Option<DebugDocBuilder>) -> DebugDocBuilder

pub fn space() -> DebugDocBuilder

pub fn newline() -> DebugDocBuilder

pub fn is_empty(&self) -> bool

pub fn or(self, doc: DebugDocBuilder) -> DebugDocBuilder

pub fn group(self) -> DebugDocBuilder

pub fn nest(self) -> DebugDocBuilder

pub fn intersperse_with_source<'a, T: PrettyDebugWithSource + 'a>(
    list: impl IntoIterator<Item = &'a T>,
    separator: DebugDocBuilder,
    source: &str
) -> DebugDocBuilder

pub fn intersperse<T: PrettyDebug>(
    list: impl IntoIterator<Item = T>,
    separator: DebugDocBuilder
) -> DebugDocBuilder

pub fn list(list: impl IntoIterator<Item = DebugDocBuilder>) -> DebugDocBuilder

Methods from Deref<Target = DocBuilder<'static, BoxAllocator, ShellAnnotation>>

Trait Implementations

impl PrettyDebug for DebugDocBuilder

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 Into<DebugDocBuilder> for DocBuilder<'static, BoxAllocator, ShellAnnotation>

fn into(self) -> DebugDocBuilder

Performs the conversion.

impl Into<Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>> for DebugDocBuilder

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

Performs the conversion.

impl Clone for DebugDocBuilder

fn clone(&self) -> DebugDocBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Add<DebugDocBuilder> for DebugDocBuilder

type Output = DebugDocBuilder

The resulting type after applying the + operator.

fn add(self, rhs: DebugDocBuilder) -> DebugDocBuilder

Performs the + operation.

impl Deref for DebugDocBuilder

type Target = DocBuilder<'static, BoxAllocator, ShellAnnotation>

The resulting type after dereferencing.

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

Dereferences the value.