Struct Template 

pub struct Template { /* private fields */ }

A parsed path template.

Implementations

impl Template

pub fn parse(source: &str) -> Result<Self, TemplateError>

Parses a template, validating its placeholders.

Whitespace inside the braces is insignificant, so {{pad day}}, {{ pad day }} and {{ pad day }} are the same placeholder.

Errors

Returns TemplateError if a placeholder is unclosed or unrecognised, or if the template is missing the year or day placeholder - both are always substituted, so a template without them can never render.

use aoc_runtime::template::{Segment, Template};

let template = Template::parse("/aoc/{{year}}/day{{ pad day }}")?;
assert_eq!(template.segments(), [
    Segment::Literal("/aoc/".into()),
    Segment::Year,
    Segment::Literal("/day".into()),
    Segment::Day { padded: true },
]);

pub fn segments(&self) -> &[Segment]

The parsed segments, in template order.

pub fn render(&self, params: Params) -> PathBuf

Renders the template into a concrete project path.

Infallible: Params carries validated values, and parsing has already rejected templates that cannot be rendered.

pub fn matcher(&self) -> Result<CwdMatcher, TemplateError>

Compiles the matcher that recovers parameters from a directory path.

Errors

Returns TemplateError::Regex if the generated pattern is rejected, which in practice only happens for pathologically large templates.

pub fn has_language(&self) -> bool

Whether the template mentions the language placeholder.

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Template

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

Formats the value using the given formatter.

impl Display for Template

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

Formats the value using the given formatter.

impl Eq for Template

impl FromStr for Template

type Err = TemplateError

The associated error which can be returned from parsing.

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

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

impl PartialEq for Template

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Template