Struct ReadmeOptions 

pub struct ReadmeOptions {
    pub add_title: bool,
    pub add_badges: bool,
    pub add_license: bool,
    pub indent_headings: bool,
    pub extract_from_comment: bool,
}

Toggles controlling how the README is generated.

Bundling these flags keeps generate_readme free of a long run of same-typed bool arguments, which are easy to transpose at the call site.

Fields

add_title: bool

Prepend the crate name as a title. Ignored when using a template.

add_badges: bool

Prepend the badges defined in Cargo.toml. Ignored when using a template.

add_license: bool

Append the license defined in Cargo.toml. Ignored when using a template.

indent_headings: bool

Add an extra level to headings so the crate name can be the top heading.

extract_from_comment: bool

Extract docs from comments rather than processing the input file as-is.

Trait Implementations

impl Clone for ReadmeOptions

fn clone(&self) -> ReadmeOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReadmeOptions

impl Debug for ReadmeOptions

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

Formats the value using the given formatter.

impl Default for ReadmeOptions

fn default() -> Self

Returns the “default value” for a type.