Struct futhorc::post::Parser[][src]

pub struct Parser<'a> { /* fields omitted */ }

Parses Post objects from source files.

Implementations

impl<'a> Parser<'a>[src]

pub fn new(
    index_url: &'a Url,
    posts_url: &'a Url,
    posts_directory: &'a Path
) -> Parser<'a>
[src]

Constructs a new parser. See fields on Parser for argument descriptions.

pub fn parse_posts(&self, source_directory: &Path) -> Result<Vec<Post>>[src]

Searches a provided source_directory for post files (extension = .md) and returns a list of Post objects sorted by date (most recent first). Each post file must be structured as follows:

  1. Initial frontmatter fence (---)
  2. YAML frontmatter with fields Title, Date, and optionally Tags
  3. Terminal frontmatter fence (---)
  4. Post body

For example:

---
Title: Hello, world!
Date: 2021-04-16
Tags: [greet]
---
# Hello

World

Auto Trait Implementations

impl<'a> RefUnwindSafe for Parser<'a>

impl<'a> Send for Parser<'a>

impl<'a> Sync for Parser<'a>

impl<'a> Unpin for Parser<'a>

impl<'a> UnwindSafe for Parser<'a>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.