Struct TemplateContext 

pub struct TemplateContext<'a> {
    pub krate: &'a str,
    pub krate_version: &'a str,
    pub target: TargetType,
    pub repository: Option<&'a str>,
    pub repository_host: Option<String>,
    pub license: Option<&'a str>,
    pub rust_version: Option<&'a Version>,
    pub readme: String,
    pub links: String,
}

This struct documents all available placeholders in the readme template.

Fields

krate: &'a str

The name of the crate.

This is renamed to crate for the template, do not use {{ krate }}, it won’t work.

krate_version: &'a str

The version of the crate.

This is renamed to crate_version for the template, do not use {{ krate_version }}, it won’t work.

target: TargetType

The target type, etiher bin or lib.

repository: Option<&'a str>

The repository variable from the Cargo.toml file, if set.

repository_host: Option<String>

The HTTP(S) host name of the repository variable, if set. This can be used to add a Codeberg icon if the code is hosted on Codeberg, for example.

license: Option<&'a str>

The license variable from the Cargo.toml file, if set. Note that in case only the license-file variable is set, this will be none.

rust_version: Option<&'a Version>

The rust_version variable from the Cargo.toml file, interpreted as a semver Version. This means that, if the Cargo.toml specifies 1.90, this variable will read 1.90.0.

readme: String

The main content of the readme. Every template should contain this variable exactly once. Place it whever it is convenient.

links: String

The links section of the readme. Place this at the bottom of the readme. You may omit this if it is empty.

Trait Implementations

impl<'a> Serialize for TemplateContext<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.