Struct MarkdownOptions 

#[non_exhaustive]
pub struct MarkdownOptions {
    pub(crate) title: Option<String>,
    pub(crate) show_footer: bool,
    pub(crate) show_table_of_contents: bool,
    pub(crate) show_aliases: bool,
}

Options to customize the structure of the output Markdown document.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

title: Option<String>

show_footer: bool

show_table_of_contents: bool

show_aliases: bool

Implementations

impl MarkdownOptions

pub fn new() -> Self

Construct a default instance of MarkdownOptions.

pub fn title(self, title: String) -> Self

Set a custom title to use in the generated document.

pub fn show_footer(self, show: bool) -> Self

Whether to show the default footer advertising clap-markdown.

pub fn show_table_of_contents(self, show: bool) -> Self

Whether to show the default table of contents.

pub fn show_aliases(self, show: bool) -> Self

Whether to show aliases for arguments and commands.

Trait Implementations

impl Default for MarkdownOptions

fn default() -> Self

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes