Struct SsgConfig 

pub struct SsgConfig {
    pub site_name: String,
    pub content_dir: PathBuf,
    pub output_dir: PathBuf,
    pub template_dir: PathBuf,
    pub serve_dir: Option<PathBuf>,
    pub base_url: String,
    pub site_title: String,
    pub site_description: String,
    pub language: String,
    pub i18n: Option<I18nConfig>,
}

Core configuration for the static site generator.

Fields

site_name: String

Name of the site.

content_dir: PathBuf

Directory containing content files.

output_dir: PathBuf

Directory for generated output files.

template_dir: PathBuf

Directory containing template files.

serve_dir: Option<PathBuf>

Optional directory for development server files.

base_url: String

Base URL of the site.

site_title: String

Title of the site.

site_description: String

Description of the site.

language: String

Language code for the site.

i18n: Option<I18nConfig>

Optional i18n configuration for multi-locale sites.

Implementations

impl SsgConfig

pub fn from_matches(matches: &ArgMatches) -> Result<Self, CliError>

Creates a configuration by merging the default values with any command-line arguments.

Arguments

• matches - Parsed command-line arguments from Clap.

Errors

Returns a CliError if:

• A path fails validation (e.g., directory traversal or symlink).
• A URL is malformed.
• The language is incorrectly formatted.

Examples

let matches = cli.build().get_matches();
let config = SsgConfig::from_matches(&matches)?;

pub fn from_file(path: &Path) -> Result<Self, CliError>

Loads configuration from a TOML file, enforcing a maximum file size limit.

Arguments

• path - The path of the TOML file to be read.

Errors

Returns a CliError if:

• The file cannot be read or exceeds MAX_CONFIG_SIZE.
• The file is malformed TOML.
• Any fields fail validation afterward.

Examples

let config = SsgConfig::from_file(Path::new("config.toml"))?;

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

Creates a new SsgConfig instance from a TOML file.

pub fn builder() -> SsgConfigBuilder

Creates a new SsgConfig instance from a TOML file.

Trait Implementations

impl Clone for SsgConfig

fn clone(&self) -> SsgConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SsgConfig

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

Formats the value using the given formatter.

impl Default for SsgConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SsgConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for SsgConfig

type Err = CliError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for SsgConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.