Skip to main content

Syntax

Struct Syntax 

Source
pub struct Syntax {
    pub expr: (String, String),
    pub block: BlockStyle,
    pub text_prefix: Option<String>,
}
Expand description

The configurable surface syntax of a template.

Fields§

§expr: (String, String)

The interpolation delimiter pair, e.g. ({{, }}).

§block: BlockStyle

How block directives are delimited.

§text_prefix: Option<String>

Optional line prefix that is stripped; content after it is emitted as text.

A physical line whose first non-whitespace characters equal this prefix has the leading whitespace and the prefix removed. The rest of the line (including a trailing newline) is ordinary template text and may contain interpolations.

When both this and a BlockStyle::Line prefix could match the same line, the longer prefix wins. They must not be identical (see Syntax::validate).

Implementations§

Source§

impl Syntax

Source

pub fn brackets() -> Self

Bracket style: {{ expr }} interpolation and {% ... %} block directives.

Source

pub fn lines() -> Self

Line style: {{ expr }} interpolation and #kw ... line directives.

Source

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

Checks that this syntax configuration is internally consistent.

Currently rejects an empty text_prefix and a text_prefix identical to the block line prefix.

Source

pub fn with_frontmatter(&self, front: &str) -> Result<Self, TemplateError>

Applies frontmatter key/value overrides onto a copy of this syntax.

Recognized keys (all optional; each may appear at most once):

  • expr: <open> <close> — interpolation delimiters.
  • block: paired <open> <close> — paired block directives.
  • block: line <prefix> — line directives.
  • text_prefix: <prefix> — strip this line prefix; remainder is verbatim text.

Blank lines and lines whose first non-whitespace character is # are ignored (comments). Keys present in front replace the corresponding fields of self; omitted keys are left unchanged. Locations in returned errors are relative to front.

Trait Implementations§

Source§

impl Clone for Syntax

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Syntax

Source§

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

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

impl Default for Syntax

Source§

fn default() -> Self

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

impl Eq for Syntax

Source§

impl PartialEq for Syntax

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Syntax

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.