Struct Paths 

pub struct Paths {
    pub site: PathBuf,
    pub content: PathBuf,
    pub build: PathBuf,
    pub template: PathBuf,
}

Represents the necessary directory paths for the site generator.

Fields

site: PathBuf

The site output directory

content: PathBuf

The content directory

build: PathBuf

The build directory

template: PathBuf

The template directory

Implementations

impl Paths

pub fn builder() -> PathsBuilder

Creates a new builder for configuring Paths

Examples

use ssg::Paths;

let paths = Paths::builder()
    .site("out")
    .content("docs")
    .build_dir("tmp")
    .template("tpl")
    .build()
    .expect("valid paths");
assert_eq!(paths.site.to_str(), Some("out"));

pub fn default_paths() -> Self

Creates paths with default directories

Examples

use ssg::Paths;

let paths = Paths::default_paths();
assert_eq!(paths.site.to_str(), Some("public"));
assert_eq!(paths.content.to_str(), Some("content"));
assert_eq!(paths.build.to_str(), Some("build"));
assert_eq!(paths.template.to_str(), Some("templates"));

impl Paths

pub fn validate(&self) -> Result<(), SsgError>

Validates all paths in the configuration

Examples

use ssg::Paths;
use std::path::PathBuf;

let good = Paths::default_paths();
assert!(good.validate().is_ok());

let bad = Paths {
    site: PathBuf::from("../escape"),
    content: PathBuf::from("content"),
    build: PathBuf::from("build"),
    template: PathBuf::from("templates"),
};
assert!(bad.validate().is_err());

Errors

Returns SsgError::PathTraversal if any path contains .., SsgError::Validation for malformed paths, or SsgError::SymlinkForbidden if a path points at a symlink.

Trait Implementations

impl Clone for Paths

fn clone(&self) -> Paths

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Paths

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

Formats the value using the given formatter.