Struct DocumentationTemplate 

pub struct DocumentationTemplate {
    pub name: String,
    pub content: String,
    pub variables: Vec<String>,
}

Documentation template

Fields

name: String

Template name

content: String

Template content

variables: Vec<String>

Template variables (placeholders)

Implementations

impl DocumentationTemplate

pub fn new(name: impl Into<String>, content: impl Into<String>) -> Self

Create a new documentation template

pub fn with_variable(self, var: impl Into<String>) -> Self

Add a variable

pub fn render(&self, values: &HashMap<String, String>) -> Result<String>

Render template with variables

Trait Implementations

impl Clone for DocumentationTemplate

fn clone(&self) -> DocumentationTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentationTemplate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentationTemplate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentationTemplate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.