Struct PathsBuilder 

pub struct PathsBuilder {
    pub site: Option<PathBuf>,
    pub content: Option<PathBuf>,
    pub build: Option<PathBuf>,
    pub template: Option<PathBuf>,
}

Builder for creating Paths configurations

Fields

site: Option<PathBuf>

The site output directory

content: Option<PathBuf>

The content directory

build: Option<PathBuf>

The build directory

template: Option<PathBuf>

The template directory

Implementations

impl PathsBuilder

pub fn site<P: Into<PathBuf>>(self, path: P) -> Self

Sets the site output directory

Examples

use ssg::PathsBuilder;

let b = PathsBuilder::default().site("dist");
assert_eq!(b.site.as_deref().and_then(|p| p.to_str()), Some("dist"));

pub fn content<P: Into<PathBuf>>(self, path: P) -> Self

Sets the content directory

Examples

use ssg::PathsBuilder;

let b = PathsBuilder::default().content("posts");
assert_eq!(b.content.as_deref().and_then(|p| p.to_str()), Some("posts"));

pub fn build_dir<P: Into<PathBuf>>(self, path: P) -> Self

Sets the build directory

Examples

use ssg::PathsBuilder;

let b = PathsBuilder::default().build_dir("work");
assert_eq!(b.build.as_deref().and_then(|p| p.to_str()), Some("work"));

pub fn template<P: Into<PathBuf>>(self, path: P) -> Self

Sets the template directory

Examples

use ssg::PathsBuilder;

let b = PathsBuilder::default().template("layouts");
assert_eq!(b.template.as_deref().and_then(|p| p.to_str()), Some("layouts"));

pub fn relative_to<P: AsRef<Path>>(self, base: P) -> Self

Sets all paths relative to a base directory

Examples

use ssg::PathsBuilder;

let paths = PathsBuilder::default()
    .relative_to("site")
    .build()
    .expect("valid");
assert!(paths.site.ends_with("public"));
assert!(paths.content.ends_with("content"));

pub fn build(self) -> Result<Paths, SsgError>

Builds the Paths configuration

Returns

• Result<Paths> - The configured paths if valid

Examples

use ssg::PathsBuilder;

let paths = PathsBuilder::default().build().expect("defaults valid");
assert_eq!(paths.site.to_str(), Some("public"));

Errors

Returns an error if:

• Required paths are missing
• Paths are invalid or unsafe
• Unable to create necessary directories

Trait Implementations

impl Clone for PathsBuilder

fn clone(&self) -> PathsBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathsBuilder

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

Formats the value using the given formatter.

impl Default for PathsBuilder

fn default() -> PathsBuilder

Returns the “default value” for a type.