Struct SsgConfigBuilder 

pub struct SsgConfigBuilder { /* private fields */ }

Builder for SsgConfig.

Implementations

impl SsgConfigBuilder

Examples

use ssg::cmd::SsgConfig;
let config = SsgConfig::builder()
    .site_name("My Site".to_string())
    .base_url("http://example.com".to_string())
    .build()
    .unwrap();

pub fn site_name(self, name: String) -> Self

Sets the site name for the configuration.

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder().site_name("Hello".into()).build().unwrap();
assert_eq!(cfg.site_name, "Hello");

pub fn base_url(self, url: String) -> Self

Sets the base URL for the configuration.

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder()
    .base_url("https://example.com".into())
    .build()
    .unwrap();
assert_eq!(cfg.base_url, "https://example.com");

pub fn content_dir(self, dir: PathBuf) -> Self

Sets the content directory for the configuration.

Examples

use ssg::cmd::SsgConfig;
use std::path::PathBuf;

let cfg = SsgConfig::builder()
    .content_dir(PathBuf::from("docs"))
    .build()
    .unwrap();
assert_eq!(cfg.content_dir, PathBuf::from("docs"));

pub fn output_dir(self, dir: PathBuf) -> Self

Sets the output directory for the configuration.

Examples

use ssg::cmd::SsgConfig;
use std::path::PathBuf;

let cfg = SsgConfig::builder()
    .output_dir(PathBuf::from("dist"))
    .build()
    .unwrap();
assert_eq!(cfg.output_dir, PathBuf::from("dist"));

pub fn template_dir(self, dir: PathBuf) -> Self

Sets the template directory for the configuration.

Examples

use ssg::cmd::SsgConfig;
use std::path::PathBuf;

let cfg = SsgConfig::builder()
    .template_dir(PathBuf::from("tpl"))
    .build()
    .unwrap();
assert_eq!(cfg.template_dir, PathBuf::from("tpl"));

pub fn serve_dir(self, dir: Option<PathBuf>) -> Self

Sets the optional development server directory for the configuration.

Examples

use ssg::cmd::SsgConfig;
use std::path::PathBuf;

let cfg = SsgConfig::builder()
    .serve_dir(Some(PathBuf::from("public")))
    .build()
    .unwrap();
assert_eq!(cfg.serve_dir, Some(PathBuf::from("public")));

pub fn site_title(self, title: String) -> Self

Sets the site title for the configuration.

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder().site_title("Title".into()).build().unwrap();
assert_eq!(cfg.site_title, "Title");

pub fn site_description(self, desc: String) -> Self

Sets the site description for the configuration.

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder().site_description("Demo".into()).build().unwrap();
assert_eq!(cfg.site_description, "Demo");

pub fn language(self, lang: String) -> Self

Sets the language code for the configuration.

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder().language("fr-FR".into()).build().unwrap();
assert_eq!(cfg.language, "fr-FR");

pub fn i18n(self, i18n: Option<I18nConfig>) -> Self

Sets the i18n configuration.

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder().i18n(None).build().unwrap();
assert!(cfg.i18n.is_none());

pub fn cdn_prefix(self, prefix: Option<String>) -> Self

Sets the CDN prefix configuration.

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder()
    .cdn_prefix(Some("https://cdn.example.com".into()))
    .build()
    .unwrap();
assert!(cfg.cdn_prefix.is_some());

pub fn og_image(self, og_image: Option<String>) -> Self

Sets the site-wide fallback og:image used by generated taxonomy/tag pages that have no per-page image of their own.

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder()
    .og_image(Some("/social/default.png".into()))
    .build()
    .unwrap();
assert_eq!(cfg.og_image.as_deref(), Some("/social/default.png"));

pub fn edge_headers(self, edge: EdgeHeadersConfig) -> Self

Sets the edge-headers emitter configuration (issue #550).

Examples

use ssg::cmd::{EdgeHeadersConfig, SsgConfig};

let cfg = SsgConfig::builder()
    .edge_headers(EdgeHeadersConfig::default())
    .build()
    .unwrap();
assert!(!cfg.edge_headers.is_enabled());

pub const fn security(self, security: SecurityConfig) -> Self

Sets the security tunables (v0.0.47 plan §3 item 2.3).

Examples

use ssg::cmd::{SecurityConfig, SriAlgorithm, SsgConfig};

let cfg = SsgConfig::builder()
    .security(SecurityConfig {
        sri_algorithm: SriAlgorithm::Sha512,
    })
    .build()
    .unwrap();
assert_eq!(cfg.security.sri_algorithm, SriAlgorithm::Sha512);

pub const fn transitions(self, enabled: bool) -> Self

Enables the View Transitions + lazy-nav client (issue #547).

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder().transitions(true).build().unwrap();
assert!(cfg.transitions);

pub fn build(self) -> Result<SsgConfig, CliError>

Builds the final SsgConfig instance.

Examples

use ssg::cmd::SsgConfig;

let cfg = SsgConfig::builder().build().expect("default is valid");
assert!(!cfg.site_name.is_empty());

Errors

Returns CliError::ValidationError when SsgConfig::validate fails.

Trait Implementations

impl Clone for SsgConfigBuilder

fn clone(&self) -> SsgConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SsgConfigBuilder

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

Formats the value using the given formatter.

impl Default for SsgConfigBuilder

fn default() -> SsgConfigBuilder

Returns the “default value” for a type.