runjucks_core 0.1.7

Pure Rust Nunjucks-compatible template engine core (Runjucks)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! User-facing render and parse failures as a simple string message.
//!
//! Functions in this crate that can fail return [`Result`]`<T, `[`RunjucksError`]`>`.

use std::fmt;

/// Error returned when lexing, parsing, or rendering cannot complete.
///
/// Carries a human-readable message suitable for logs or passing to JavaScript via the NAPI layer.
///
/// # Examples
///
/// ```
/// use runjucks_core::RunjucksError;
///
/// let e = RunjucksError::new("unclosed tag");
/// assert_eq!(e.to_string(), "unclosed tag");
/// ```
#[derive(Debug)]
pub struct RunjucksError {
    message: String,
}

impl RunjucksError {
    /// Creates an error with the given message.
    pub fn new(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
        }
    }
}

impl fmt::Display for RunjucksError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&self.message)
    }
}

impl std::error::Error for RunjucksError {}

/// Convenient alias for `std::result::Result` with [`RunjucksError`] as the error type.
pub type Result<T> = std::result::Result<T, RunjucksError>;