Trait blue_build_template::Template

pub trait Template: Display {
    const EXTENSION: Option<&'static str>;
    const SIZE_HINT: usize;
    const MIME_TYPE: &'static str;

    // Required method
    fn render_into<W>(&self, writer: &mut W) -> Result<(), Error>
       where W: Write + ?Sized;

    // Provided methods
    fn render(&self) -> Result<String, Error> { ... }
    fn write_into<W>(&self, writer: &mut W) -> Result<(), Error>
       where W: Write + ?Sized { ... }
}

Main Template trait; implementations are generally derived

If you need an object-safe template, use DynTemplate.

Required Associated Constants

const EXTENSION: Option<&'static str>

The template’s extension, if provided

const SIZE_HINT: usize

Provides a rough estimate of the expanded length of the rendered template. Larger values result in higher memory usage but fewer reallocations. Smaller values result in the opposite. This value only affects render. It does not take effect when calling render_into, write_into, the fmt::Display implementation, or the blanket ToString::to_string implementation.

const MIME_TYPE: &'static str

The MIME type (Content-Type) of the data that gets rendered by this Template

Required Methods

fn render_into<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

Renders the template to the given writer fmt buffer

Provided Methods

fn render(&self) -> Result<String, Error>

Helper method which allocates a new String and renders into it

fn write_into<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

Renders the template to the given writer io buffer

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl<T> Template for &T

where T: Template + ?Sized,

const EXTENSION: Option<&'static str> = T::EXTENSION

const SIZE_HINT: usize = T::SIZE_HINT

const MIME_TYPE: &'static str = T::MIME_TYPE

fn render_into<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

fn render(&self) -> Result<String, Error>

fn write_into<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

Implementors

impl<'a> Template for ContainerFileTemplate<'a>

const EXTENSION: Option<&'static str> = _

const SIZE_HINT: usize = 2_456usize

const MIME_TYPE: &'static str = "application/octet-stream"

impl<'a> Template for GithubIssueTemplate<'a>

const EXTENSION: Option<&'static str> = _

const SIZE_HINT: usize = 684usize

const MIME_TYPE: &'static str = "application/octet-stream"

impl<'a> Template for InitReadmeTemplate<'a>

const EXTENSION: Option<&'static str> = _

const SIZE_HINT: usize = 1_826usize

const MIME_TYPE: &'static str = "application/octet-stream"