Struct BuildError 

pub struct BuildError {
    pub file: Option<String>,
    pub line: Option<usize>,
    pub message: String,
}

Serialisable build error for browser overlay delivery.

Fields

file: Option<String>

Source file path (if extractable from the error chain).

line: Option<usize>

Line number (if extractable).

message: String

Human-readable error message.

Implementations

impl BuildError

pub fn from_error(err: &SsgError) -> Self

Creates a BuildError from an SsgError error, attempting to extract file path and line number from the error chain.

Examples

use ssg::pipeline::BuildError;
use ssg::SsgError;

let err = SsgError::Validation { field: "x".into(), message: "nope".into() };
let be = BuildError::from_error(&err);
assert!(be.message.contains("nope"));

pub fn to_ws_message(&self) -> String

Serializes to a WebSocket JSON message.

Examples

use ssg::pipeline::BuildError;

let be = BuildError { file: None, line: None, message: "boom".into() };
let msg = be.to_ws_message();
assert!(msg.contains("\"type\":\"error\""));
assert!(msg.contains("boom"));

Trait Implementations

impl Clone for BuildError

fn clone(&self) -> BuildError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildError

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

Formats the value using the given formatter.

impl Serialize for BuildError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.