serde-frontmatter

Crates.ioserde-frontmatter
lib.rsserde-frontmatter
version0.1.0
sourcesrc
created_at2021-07-17 16:42:41.535873
updated_at2021-07-17 16:42:41.535873
descriptionSerde support for Jekyll front matter
homepagehttps://github.com/ewpratten/serde-frontmatter
repositoryhttps://github.com/ewpratten/serde-frontmatter
max_upload_size
id424088
size43,734
Evan Pratten (ewpratten)

documentation

https://docs.rs/serde-frontmatter

README

serde-frontmatter

Crates.io Docs.rs Build Clippy Audit

This crate is a Rust library for using the Serde serialization framework with Jekyll-style front matter.

Examples

use serde::{Deserialize, Serialize};

#[derive(Deserialize, Serialize, PartialEq, Debug)]
pub struct MyData {
    pub title: String
}

fn main() {
    // Serialize
    let front_matter = MyData { title: "Hello, World!".to_string() };
    let content = "This is some content";
    let output = serde_frontmatter::serialize(front_matter, content).unwrap();
    assert_eq!("---\ntitle: \"Hello, World!\"\n\n---\nThis is some content", output);

    // Deserialize
    let input = "---\ntitle: Hello, World!\n---\nThis is some content";
    let (front_matter, content) = serde_frontmatter::deserialize::<MyData>(input).unwrap();
    assert_eq!(front_matter, MyData { title: "Hello, World!".to_string() });
    assert_eq!(content, "\nThis is some content");
}
Commit count: 2

cargo fmt