Struct ramhorns::Template

source ·
pub struct Template<'tpl> { /* private fields */ }
Expand description

A preprocessed form of the plain text template, ready to be rendered with data contained in types implementing the Content trait.

Implementations§

source§

impl<'tpl> Template<'tpl>

source

pub fn new<S>(source: S) -> Result<Self, Error>
where S: Into<Cow<'tpl, str>>,

Create a new Template out of the source.

  • If source is a &str, this Template will borrow it with appropriate lifetime.
  • If source is a String, this Template will take it’s ownership (The 'tpl lifetime will be 'static).
source

pub fn capacity_hint(&self) -> usize

Estimate how big of a buffer should be allocated to render this Template.

source

pub fn render<C: Content>(&self, content: &C) -> String

Render this Template with a given Content to a String.

source

pub fn render_to_writer<W, C>(&self, writer: &mut W, content: &C) -> Result<()>
where W: Write, C: Content,

Render this Template with a given Content to a writer.

source

pub fn render_to_file<P, C>(&self, path: P, content: &C) -> Result<()>
where P: AsRef<Path>, C: Content,

Render this Template with a given Content to a file.

source

pub fn source(&self) -> &str

Get a reference to a source this Template was created from.

Trait Implementations§

source§

impl<'tpl> Debug for Template<'tpl>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'tpl> Freeze for Template<'tpl>

§

impl<'tpl> RefUnwindSafe for Template<'tpl>

§

impl<'tpl> Send for Template<'tpl>

§

impl<'tpl> Sync for Template<'tpl>

§

impl<'tpl> Unpin for Template<'tpl>

§

impl<'tpl> UnwindSafe for Template<'tpl>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.