Skip to main content

Template

Struct Template 

Source
pub struct Template { /* private fields */ }
Expand description

Precompiled version of the string template.

Implementations§

Source§

impl Template

Source

pub fn new() -> Self

Create an empty template, which can be filled using the builders.

use dfmt::*;
let formatted_string = Template::new()
    .literal("Hello, ")
    .specified_argument(0, Specifier::default())
    .literal("!")
    .arguments()
    .builder()
    .display(0, &"World")
    .format()
    .unwrap();
println!("{}", formatted_string);
Source

pub fn parse(template: &str) -> Result<Self, Error>

Parses a string template.

Source

pub fn expect_all_arguments_to_meet_constraints( &self, allowed_specifier: &AllowedSpecifier, ) -> Result<&Self, Error>

Expects that all arguments meet the specified constraints.

Source

pub fn expect_argument<K: ToArgumentKey>( &self, key: K, allowed_specifier: &AllowedSpecifier, ) -> Result<&Self, Error>

Expect a specified argument within a parsed template

Source

pub fn arguments(&self) -> Arguments<'_>

Transition into Arguments for convinience.

Source

pub fn literal<V: ToString>(self, literal: V) -> Self

Builder to add a literal piece.

Source

pub fn specified_argument<K: ToArgumentKey>( self, key: K, specifier: Specifier, ) -> Self

Builder to add an argument with a specifier.

Source

pub fn argument<K: ToArgumentKey>(self, key: K) -> Self

Builder to add an argument without a specifier.

Source

pub fn argument_type_requirements( &self, argument_key: &ArgumentKey, ) -> Result<&ArgumentTypeRequirements, Error>

Trait Implementations§

Source§

impl Clone for Template

Source§

fn clone(&self) -> Template

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Template

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Template

Source§

fn default() -> Template

Returns the “default value” for a type. Read more
Source§

impl Display for Template

Source§

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

Formats the value using the given formatter. Read more
Source§

impl DynFmt for Template

Source§

fn format( &self, argument_values: Vec<(&dyn ToArgumentKey, ArgumentValue<'_>)>, ) -> Result<String, Error>

Source§

fn format_unchecked( &self, argument_values: Vec<(&dyn ToArgumentKey, ArgumentValue<'_>)>, ) -> String

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

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>,

Source§

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.