Struct Template

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

String template with std::fmt syntax.

§Example

use formatx::Template;

let mut template = "{percentage:.2}".parse::<Template>().unwrap();
template.replace("percentage", 67.7892);
assert_eq!(template.text().unwrap(), "67.79");

Implementations§

Source§

impl Template

Source

pub fn new<T: Into<String>>(template: T) -> Result<Self, Error>

Create a new instance of format_template::Template.

§Example
use formatx::Template;

let template = Template::new("{percentage:.2}").unwrap();
Source

pub fn contains<T: ToString>(&self, placeholder: T) -> bool

Checks wheter template contains placeholder or not.

Source

pub fn unchecked_text(&self) -> String

Returns unchecked formatted template. For Result version of fomatted template use .text method.

Source

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

Checks wheter all placeholders are replaced or not and returns formatted template.

Examples found in repository?
examples/advance.rs (line 18)
3fn main() {
4    let mut template = "{percentage color=true:.2} => {percentage color=false:.0}%"
5        .parse::<Template>()
6        .unwrap();
7
8    template.replace_with_callback("percentage", 99.9999, |fmtval, placeholder| {
9        if let Some(color) = placeholder.attr("color") {
10            if color == "true" {
11                return "\x1b[31m".to_owned() + &fmtval + "\x1b[0m";
12            }
13        }
14
15        fmtval
16    });
17
18    println!("{}", template.text().unwrap());
19}
Source

pub fn replace<T, U>(&mut self, placeholder: T, value: U)
where T: ToString, U: Display + Debug,

Replace a template placeholder with a value. This change is inplace.

Source

pub fn replace_positional<T>(&mut self, value: T)
where T: Display + Debug,

Replace a template positional placeholder with a value. This change is inplace.

Source

pub fn replace_from_callback<T, U>(&mut self, placeholder: T, callback: U)
where T: ToString, U: Fn(&Placeholder) -> String,

Replace a template placeholder from a callback String. This change is inplace.

Source

pub fn replace_with_callback<T, U, V>( &mut self, placeholder: T, value: U, callback: V, )
where T: ToString, U: Display + Debug, V: Fn(String, &Placeholder) -> String,

Replace a template placeholder with a value and do additional formatting using callback. This change is inplace.

Examples found in repository?
examples/advance.rs (lines 8-16)
3fn main() {
4    let mut template = "{percentage color=true:.2} => {percentage color=false:.0}%"
5        .parse::<Template>()
6        .unwrap();
7
8    template.replace_with_callback("percentage", 99.9999, |fmtval, placeholder| {
9        if let Some(color) = placeholder.attr("color") {
10            if color == "true" {
11                return "\x1b[31m".to_owned() + &fmtval + "\x1b[0m";
12            }
13        }
14
15        fmtval
16    });
17
18    println!("{}", template.text().unwrap());
19}

Trait Implementations§

Source§

impl Clone for Template

Source§

fn clone(&self) -> Template

Returns a copy 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 Display for Template

Source§

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

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

impl FromStr for Template

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.