Struct cargo_doc2readme::output::Readme

struct Readme<'a> {
    template: &'a str,
    input: &'a InputFile,
    readme: String,
    readme_links: String,
    links: BTreeMap<String, String>,
}

Fields

template: &'a str

input: &'a InputFile

readme: String

Holds the main markdown part of the readme that was created from the rustdoc, but does not include any parts of the template or the links.

readme_links: String

Holds the link part of the markdown.

links: BTreeMap<String, String>

Implementations

impl<'a> Readme<'a>

fn new(template: &'a str, input: &'a InputFile) -> Self

fn write_markdown(&mut self) -> Result

fn write_links(&mut self)