Struct shtola::ShFile

pub struct ShFile {
    pub frontmatter: Value,
    pub content: Vec<u8>,
    pub raw_content: Option<Vec<u8>>,
}

Shtola’s file representation, with frontmatter included.

Fields

frontmatter: Value

The frontmatter.

content: Vec<u8>

The file contents (without frontmatter). UTF-8-encoded.

raw_content: Option<Vec<u8>>

Raw content for anything that can’t be read as UTF-8.

Implementations

impl ShFile

pub fn empty() -> ShFile

Creates an empty ShFile. Useful for deleting files using HashMap::difference:

use shtola::{Plugin, RefIR, ShFile, HashMap};
use std::path::PathBuf;

fn plugin() -> Plugin {
  Box::new(|mut ir: RefIR| {
    ir.files.insert("empty-file.md".into(), ShFile::empty());
  })
}

Trait Implementations

impl Clone for ShFile

fn clone(&self) -> ShFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShFile

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

Formats the value using the given formatter.

impl Default for ShFile

fn default() -> ShFile

Returns the “default value” for a type.