FrontmatterParser

Struct FrontmatterParser 

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

Unified frontmatter parser with templating support.

This struct provides a centralized interface for parsing frontmatter from content using the grey_matter library, with optional Tera templating support. It handles YAML, TOML, and JSON frontmatter formats automatically.

Implementations§

Source§

impl FrontmatterParser

Source

pub fn new() -> Self

Create a new frontmatter parser.

Source

pub fn with_project_dir(project_dir: PathBuf) -> Result<Self>

Create a new frontmatter parser with custom project directory.

§Arguments
  • project_dir - Project root directory for template rendering
Source

pub fn parse_with_templating<T>( &mut self, content: &str, variant_inputs: Option<&Value>, file_path: &Path, context: Option<&OperationContext>, ) -> Result<ParsedFrontmatter<T>>

Parse content and extract frontmatter with optional templating.

This method provides the complete parsing pipeline:

  1. Extract frontmatter using gray_matter
  2. Apply Tera templating if variant_inputs is provided
  3. Deserialize the result to the target type
§Arguments
  • content - The content to parse
  • variant_inputs - Optional template variables (project, config, etc.)
  • file_path - Path to the file (used for error reporting)
  • context - Optional operation context for warning deduplication
§Returns
  • ParsedFrontmatter<T> - The parsed result with data and content
Source

pub fn parse<T>(&self, content: &str) -> Result<ParsedFrontmatter<T>>

Simple parse without templating, just extract frontmatter and content.

§Arguments
  • content - The content to parse
§Returns
  • ParsedFrontmatter<T> - The parsed result with data and content
Source

pub fn has_frontmatter(&self, content: &str) -> bool

Check if content has frontmatter.

§Arguments
  • content - The content to check
§Returns
  • bool - True if frontmatter is present
Source

pub fn strip_frontmatter(&self, content: &str) -> String

Extract just the content without frontmatter.

§Arguments
  • content - The content to process
§Returns
  • String - Content with frontmatter removed
Source

pub fn extract_raw_frontmatter(&self, content: &str) -> Option<String>

Extract just the raw frontmatter string.

§Arguments
  • content - The content to process
§Returns
  • Option<String> - Raw frontmatter as YAML string, if present
Source

pub fn apply_templating( &mut self, content: &str, variant_inputs: Option<&Value>, file_path: &Path, ) -> Result<String>

Apply Tera templating to content.

Always renders the content as a template to catch syntax errors. If variant_inputs is provided, it’s used for template variables. Otherwise, renders with an empty context.

§Arguments
  • content - The content to template
  • variant_inputs - Optional template variables (project, config, etc.)
  • file_path - Path to file for error reporting
§Returns
  • Result<String> - Templated content or error

Trait Implementations§

Source§

impl Clone for FrontmatterParser

Source§

fn clone(&self) -> Self

Returns a duplicate 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 FrontmatterParser

Source§

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

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

impl Default for FrontmatterParser

Source§

fn default() -> Self

Returns the “default value” for a 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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,