Struct Config 

pub struct Config {
    pub data: ConfigData,
    pub asset_manifest: AssetManifest,
    /* private fields */
}

Main configuration structure with embedded Lua state

Fields

data: ConfigData

asset_manifest: AssetManifest

Implementations

impl Config

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self>

Load config from a Lua file

pub fn load_with_tracker<P: AsRef<Path>>( path: P, tracker: SharedTracker, ) -> Result<Self>

Load config with a custom tracker

pub fn tracker(&self) -> &SharedTracker

Get a reference to the build tracker

pub fn call_before_build(&self) -> Result<()>

Call before_build hook with ctx

pub fn call_after_build(&self) -> Result<()>

Call after_build hook with ctx

pub fn call_data(&self) -> Result<Value>

Call the data(ctx) function to get global template data

pub fn call_pages(&self, global_data: &Value) -> Result<Vec<PageDef>>

Call the pages(ctx) function to get page definitions ctx.data contains the result from data()

pub fn has_update_data(&self) -> bool

Check if update_data function is defined

pub fn call_update_data( &self, cached_data: &Value, changed_paths: &[PathBuf], ) -> Result<Value>

Call update_data(ctx) for incremental updates ctx.data = cached data, ctx.changed_paths = list of changed paths

pub fn render_markdown(&self, content: &str) -> Result<String>

Render markdown content using rs.markdown.render with default plugins

Trait Implementations

impl Deref for Config

type Target = ConfigData

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Config

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.