Struct FormatString

pub struct FormatString { /* private fields */ }

Format string wrapper struct.

This struct wraps a string and has a counter of each template it has with each respective position for the sake of replacing these positions with read data.

Implementations

impl FormatString

pub fn from_data(original: &str, spans: Vec<(String, Range<usize>)>) -> Self

Compile-time to runtime transformation function.

This function takes data that may be generated from a macro output and constructs an instance of FormatString keeping its fields private an immutable.

If you use this to construct the instance manually there is no promise that the string and spans are aligned, thus the replacements are going to work.

Parameters

• original - What belongs to the original field.
• spans - What belongs to the spans field.

Returns An instance of self based on the provided parameters.

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

Creates replaced original string copy.

This method takes the original string, and replaces it’s templates with the values of the values provided as a hashmap.

Parameters

• values - The values to replace the templates with.

Returns A copy of the original string with it’s templates replaced.

Trait Implementations

impl FromStr for FormatString

Parse method implementation.

This implementation leads to the implementation of the parse method for FormatString which parses all the templates on the string and stores them in a structure along the original string for future replacement.

type Err = TemplateError

The associated error which can be returned from parsing.

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

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

impl ToTokens for FormatString

Compile-time to runtime conversion implementation.

This implementation generates a call to the from_data function in FormatString.

fn to_tokens(&self, tokens: &mut TokenStream2)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.