Struct StaticSiteGenerator 

pub struct StaticSiteGenerator { /* private fields */ }

Available on crate feature ssg only.

Writes rendered pages and assets into an output directory.

Examples

use winged_rust::prelude::*;
use winged_rust::{Document, ssg::StaticSiteGenerator};

let site = StaticSiteGenerator::new("dist");
site.clean(true)?;
site.generate(&Document::new(Some("pt-BR")), "index.html", &RenderOptions::pretty())?;

Implementations

impl StaticSiteGenerator

pub fn new(output_directory: impl Into<PathBuf>) -> Self

Creates a generator writing into output_directory.

pub fn output_directory(&self) -> &Path

The directory pages are written into.

pub fn generate( &self, document: &Document, path: &str, options: &RenderOptions, ) -> Result<()>

Renders a document to path, relative to the output directory.

Errors

Returns an error if the path escapes the output directory, or if the write fails.

pub fn generate_multiple( &self, documents: &[(Document, String)], options: &RenderOptions, ) -> Result<()>

Renders several documents.

With the parallel feature the pages are rendered concurrently — sound because the node tree is Send + Sync, which Winged-Swift’s reference-typed tree is not.

Every failure is reported, not just the first: a bulk build that names one of twelve broken pages is worse than useless.

Errors

Returns an error naming every page that failed.

pub fn generate_page( &self, page: &Node, path: &str, options: &RenderOptions, doctype: bool, ) -> Result<()>

Renders a bare node to path, optionally prefixed by the doctype.

Errors

Returns an error if the path is unsafe or the write fails.

pub fn copy_asset(&self, from: impl AsRef<Path>, to: &str) -> Result<()>

Copies a file into the output directory, replacing any existing destination.

Errors

Returns an error if the destination is unsafe or the copy fails.

pub fn clean(&self, create_directory: bool) -> Result<()>

Removes the output directory, optionally recreating it empty.

Errors

Returns an error if the output directory is unsafe to delete — empty, the filesystem root, or containing a .. component. Winged-Swift’s version has no such guard and will happily recurse through whatever it is pointed at.

pub fn write_file(&self, content: &str, path: &str) -> Result<()>

Writes UTF-8 content to path, creating parent directories.

The write is atomic: content goes to a temporary file in the same directory and is then renamed, so a reader never sees a half-written page.

Errors

Returns an error if the path escapes the output directory or the write fails.

Trait Implementations

impl Clone for StaticSiteGenerator

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StaticSiteGenerator

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

Formats the value using the given formatter.