Struct markings::Opts

pub struct Opts { /* fields omitted */ }

Opts are a set of options to configure how a template will be parsed and applied

The default options would fail if

• there is an empty template (e.g. no replacement keys)
• there are duplicate keys
• apply will fail if the exact keys aren't applied

default options

let input = "this is a ${name}.";
let template = Template::parse(&input, Opts::default()).unwrap();

various options

// this will allow these options in the parsing/application
let opts = Opts::default()
    .optional_keys()  // optional keys -- args aren't required to match the template keys
    .duplicate_keys() // duplicate keys -- duplicate keys in the template will use the same argument
    .empty_template() // templates can just be strings that act as an "identity"
    .build();

let input = "this is a ${name}.";
let template = Template::parse(&input, opts).unwrap();

Methods

impl Opts

pub fn optional_keys(&mut self) -> &mut Self

Allow optional keys

Keys found in the template application don't have to appear in the template

pub fn duplicate_keys(&mut self) -> &mut Self

Allow duplicate keys

Multiple keys in the template will be replaced by the same argument

pub fn empty_template(&mut self) -> &mut Self

Allows for an empty template -- e.g. a template without any args

When args are applied to this, the original string is returned

pub fn build(self) -> Self

Construct the option set

Trait Implementations

impl Clone for Opts

fn clone(&self) -> Opts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Opts

impl Debug for Opts

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

Formats the value using the given formatter.

impl Default for Opts

fn default() -> Opts

Returns the "default value" for a type.

impl PartialEq<Opts> for Opts

fn eq(&self, other: &Opts) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Opts) -> bool

This method tests for !=.

impl StructuralPartialEq for Opts