frameassembly 1.0.1

A Domain-Specific Language (DSL) for writing deterministic network traffic to .pcap files.
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

use alloc::string::String;
use miette::Diagnostic;

/// Represents all possible errors that can occur during the compilation process.
///
/// This enum uses `miette` for rich terminal diagnostics.
#[derive(Diagnostic, Debug)]
pub enum CompilerError {
    /// Occurs when the lexer encounters an invalid sequence of characters that cannot be tokenized.
    #[diagnostic(
        code(frameassembly::lex_error),
        help("Check the token for typos or invalid characters.")
    )]
    LexError {
        /// The source code snippet.
        #[source_code]
        src: String,
        /// The span of the error.
        #[label("Invalid token")]
        span: (usize, usize),
    },

    /// Occurs when the parser encounters a syntax error or unexpected token.
    #[diagnostic(
        code(frameassembly::parse_error),
        help("Ensure the syntax matches the expected grammar.")
    )]
    ParseError {
        /// The parser error message.
        message: String,
        /// The source code snippet.
        #[source_code]
        src: String,
        /// The span of the error.
        #[label("Here")]
        span: (usize, usize),
    },

    /// Occurs when the AST is syntactically valid but semantically invalid (e.g. undefined variable).
    #[diagnostic(code(frameassembly::semantic_error))]
    SemanticError {
        /// The semantic error message.
        message: String,
        /// The source code snippet.
        #[source_code]
        src: String,
        /// The span of the error.
        #[label("Error occurred here")]
        span: (usize, usize),
    },

    /// Occurs during the backend PCAP generation (e.g. invalid IP address formatting, missing file access).
    #[diagnostic(code(frameassembly::backend_error))]
    BackendError(String),
}

impl core::fmt::Display for CompilerError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::LexError { .. } => write!(f, "Failed to parse token"),
            Self::ParseError { message, .. } => write!(f, "Failed to parse input: {}", message),
            Self::SemanticError { message, .. } => write!(f, "Semantic error: {}", message),
            Self::BackendError(msg) => write!(f, "Backend generation error: {}", msg),
        }
    }
}

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