Struct bpaf::Doc

pub struct Doc { /* private fields */ }

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>

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.

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

Examples found in repository

examples/customize_help.rs (line 17)

fn main() {
    let opt = short('d')
        .help("Release the dragon")
        .switch()
        .to_options()
        .descr("I am a program and I do things")
        .header("Sometimes they even work.")
        .footer("Beware `-d`, dragons be here")
        .with_usage(|doc| {
            let mut u = Doc::default();
            u.emphasis("You can call it with following flags:");
            u.text(" ");
            u.doc(&doc);
            u
        })
        .run();

    println!("{:?}", opt);
}

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

Examples found in repository

examples/customize_help.rs (line 16)

fn main() {
    let opt = short('d')
        .help("Release the dragon")
        .switch()
        .to_options()
        .descr("I am a program and I do things")
        .header("Sometimes they even work.")
        .footer("Beware `-d`, dragons be here")
        .with_usage(|doc| {
            let mut u = Doc::default();
            u.emphasis("You can call it with following flags:");
            u.text(" ");
            u.doc(&doc);
            u
        })
        .run();

    println!("{:?}", opt);
}

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

Examples found in repository

examples/customize_help.rs (line 18)

fn main() {
    let opt = short('d')
        .help("Release the dragon")
        .switch()
        .to_options()
        .descr("I am a program and I do things")
        .header("Sometimes they even work.")
        .footer("Beware `-d`, dragons be here")
        .with_usage(|doc| {
            let mut u = Doc::default();
            u.emphasis("You can call it with following flags:");
            u.text(" ");
            u.doc(&doc);
            u
        })
        .run();

    println!("{:?}", opt);
}

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

Trait Implementations

impl Clone for Doc

fn clone(&self) -> Doc

Returns a copy 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.