pklr 3.0.4

Pure Rust pkl configuration language parser and evaluator
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

// The Lex/Parse variant fields are read by miette's Diagnostic derive macro,
// but rustc can't see through the proc-macro expansion.
#![allow(unused_assignments)]

use std::path::PathBuf;

#[cfg(feature = "miette-diagnostics")]
use miette::NamedSource;

pub type Result<T> = std::result::Result<T, Error>;

#[cfg_attr(feature = "miette-diagnostics", derive(miette::Diagnostic))]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    #[error("IO error reading {0}: {1}")]
    Io(PathBuf, #[source] std::io::Error),

    #[error("{message}")]
    #[cfg_attr(feature = "miette-diagnostics", diagnostic())]
    Lex {
        #[cfg(feature = "miette-diagnostics")]
        #[source_code]
        src: NamedSource<String>,
        #[cfg(feature = "miette-diagnostics")]
        #[label("{message}")]
        span: miette::SourceOffset,
        #[cfg(not(feature = "miette-diagnostics"))]
        source_name: String,
        #[cfg(not(feature = "miette-diagnostics"))]
        offset: usize,
        message: String,
    },

    #[error("{message}")]
    #[cfg_attr(feature = "miette-diagnostics", diagnostic())]
    Parse {
        #[cfg(feature = "miette-diagnostics")]
        #[source_code]
        src: NamedSource<String>,
        #[cfg(feature = "miette-diagnostics")]
        #[label("{message}")]
        span: miette::SourceOffset,
        #[cfg(not(feature = "miette-diagnostics"))]
        source_name: String,
        #[cfg(not(feature = "miette-diagnostics"))]
        offset: usize,
        message: String,
    },

    #[error("Eval error: {0}")]
    Eval(String),

    #[error("Import not found: {0}")]
    ImportNotFound(String),

    #[error("Unsupported feature: {0}")]
    Unsupported(String),
}

impl Error {
    pub fn lex(source_name: &str, source: &str, offset: usize, message: String) -> Self {
        #[cfg(feature = "miette-diagnostics")]
        {
            Self::Lex {
                src: NamedSource::new(source_name, source.to_string()),
                span: miette::SourceOffset::from(offset),
                message,
            }
        }
        #[cfg(not(feature = "miette-diagnostics"))]
        {
            let _ = source;
            Self::Lex {
                source_name: source_name.to_string(),
                offset,
                message,
            }
        }
    }

    pub fn parse(source_name: &str, source: &str, offset: usize, message: String) -> Self {
        #[cfg(feature = "miette-diagnostics")]
        {
            Self::Parse {
                src: NamedSource::new(source_name, source.to_string()),
                span: miette::SourceOffset::from(offset),
                message,
            }
        }
        #[cfg(not(feature = "miette-diagnostics"))]
        {
            let _ = source;
            Self::Parse {
                source_name: source_name.to_string(),
                offset,
                message,
            }
        }
    }

    pub fn source_offset(&self) -> Option<usize> {
        match self {
            #[cfg(feature = "miette-diagnostics")]
            Self::Lex { span, .. } | Self::Parse { span, .. } => Some(span.offset()),
            #[cfg(not(feature = "miette-diagnostics"))]
            Self::Lex { offset, .. } | Self::Parse { offset, .. } => Some(*offset),
            _ => None,
        }
    }
}