Enum SsgError 

#[non_exhaustive]
pub enum SsgError {
    Core(Error),
    Io {
        path: PathBuf,
        source: Error,
    },
    PathTraversal {
        path: PathBuf,
    },
    SymlinkForbidden {
        path: PathBuf,
    },
    Validation {
        field: String,
        message: String,
    },
    Template(Error),
    LlmEndpointUnreachable {
        url: String,
        source: Box<dyn Error + Send + Sync>,
    },
    LlmTimeout {
        duration: Duration,
    },
    LlmInvalidResponse {
        message: String,
    },
}

Error variants for the main ssg library.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Core(Error)

Errors originating from the pure-logic compilation core.

Io

File I/O failure with context.

Fields

path: PathBuf

The path where the I/O error occurred.

source: Error

The underlying I/O error source.

PathTraversal

Path traversal detected in configuration paths.

Fields

path: PathBuf

The path violating safety requirements.

SymlinkForbidden

Symlinks are not allowed for security reasons.

Fields

path: PathBuf

The symlink path.

Validation

Configuration field validation failure.

Fields

field: String

The configuration field that failed validation.

message: String

The validation failure message.

Template(Error)

Template engine rendering errors. Gated by template feature.

LlmEndpointUnreachable

The local LLM endpoint (Ollama, llama.cpp) could not be reached. Surfaced from the ureq-backed LlmPlugin HTTP path (issue #520) when the TCP connection is refused, the host is unresolvable, or the transport layer fails before the request is sent.

Fields

url: String

The endpoint URL that failed to connect.

source: Box<dyn Error + Send + Sync>

The underlying transport error from ureq.

LlmTimeout

The local LLM call exceeded the configured llm.timeout_secs budget before returning a response. Reported as a typed error (issue #520) so callers can distinguish a slow model from a genuine network outage. There is no zombie subprocess to reap — the previous curl shellout has been removed.

Fields

duration: Duration

The timeout budget that was exceeded.

LlmInvalidResponse

The LLM responded but the payload was not a well-formed JSON generation response (missing the response field, non-UTF-8 body, malformed JSON, or HTTP non-2xx status code without a usable error envelope). Surfaced from the ureq HTTP path (issue #520).

Fields

message: String

Human-readable description of what was malformed.

Implementations

impl SsgError

pub fn io(err: impl Into<Error>, path: impl Into<PathBuf>) -> Self

Converts a generic error and path context into an SsgError::Io variant.

Examples

use ssg::SsgError;
use std::io;
use std::path::PathBuf;

let io_err = io::Error::other("oops");
let err = SsgError::io(io_err, "data/file.txt");
assert!(matches!(err, SsgError::Io { .. }));
assert!(format!("{err}").contains("data/file.txt"));

Trait Implementations

impl Debug for SsgError

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

Formats the value using the given formatter.

impl Display for SsgError

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

Formats the value using the given formatter.

impl Error for SsgError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for SsgError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SsgError

fn from(source: Error) -> Self

Converts to this type from the input type.