Struct Doc 

pub struct Doc {
    payload: String,
    tokens: Vec<Token>,
}

String with styled segments.

You can add style information to generated documentation and help messages For simpliest possible results you can also pass a string slice in all the places that require impl Into<Doc>

Fields

payload: String

string info saved here

tokens: Vec<Token>

string meta info tokens

Implementations

impl Doc

pub fn monochrome(&self, full: bool) -> String

Render a monochrome version of the document

full indicates if full message should be rendered, this makes difference for rendered help message, otherwise you can pass true.

pub(crate) fn render_console( &self, full: bool, color: Color, max_width: usize, ) -> String

impl Doc

pub fn render_markdown(&self, full: bool) -> String

Render doc into markdown document, used by documentation sample generator

impl Doc

pub fn text(&mut self, text: &str)

Append a fragment of plain text to Doc

See Doc for usage examples

pub fn literal(&mut self, text: &str)

Append a fragment of literal text to Doc

See Doc for usage examples

pub fn emphasis(&mut self, text: &str)

Append a fragment of text with emphasis to Doc

See Doc for usage examples

pub fn invalid(&mut self, text: &str)

Append a fragment of unexpected user input to Doc

See Doc for usage examples

pub fn meta(&mut self, meta: MetaInfo<'_>, for_usage: bool)

Append a fragment of parser metadata to Doc

See Doc for usage examples

pub fn doc(&mut self, buf: &Doc)

Append a Doc to Doc

See Doc for usage examples

pub fn em_doc(&mut self, buf: &Doc)

Append a Doc to Doc for plaintext documents try to format first line as a help section header

impl Doc

pub(crate) fn write_shortlong(&mut self, name: &ShortLong)

pub(crate) fn write_item(&mut self, item: &Item)

pub(crate) fn write_meta(&mut self, meta: &Meta, for_usage: bool)

impl Doc

pub(crate) fn is_empty(&self) -> bool

pub(crate) fn first_line(&self) -> Option<Doc>

impl Doc

pub(crate) fn token(&mut self, token: Token)

pub(crate) fn write<T>(&mut self, input: T, style: Style)

where T: Display,

fn set_style(&mut self, len: usize, style: Style)

pub(crate) fn write_str(&mut self, input: &str, style: Style)

pub(crate) fn write_char(&mut self, c: char, style: Style)

impl Doc

pub(crate) fn metavar(&mut self, metavar: Metavar)

impl Doc

pub(crate) fn write_help_item_groups( &mut self, items: HelpItems<'_>, include_env: bool, )

fn write_help_items( &mut self, items: &HelpItems<'_>, ty: HiTy, name: &str, include_env: bool, )

pub(crate) fn write_path(&mut self, path: &[String])

Trait Implementations

impl Clone for Doc

fn clone(&self) -> Doc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Doc

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

Formats the value using the given formatter.

impl Default for Doc

fn default() -> Doc

Returns the “default value” for a type.

impl Display for Doc

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

Formats the value using the given formatter.

impl From<&[(&str, Style)]> for Doc

fn from(val: &[(&str, Style)]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<&'static [(&'static str, Style); N]> for Doc

fn from(val: &'static [(&'static str, Style); N]) -> Self

Converts to this type from the input type.

impl From<&str> for Doc

fn from(value: &str) -> Self

Converts to this type from the input type.