shuck-parser 0.0.17

A fast, safe bash parser library
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

//! Error types for shuck

/// Result type alias using shuck's Error.
pub type Result<T> = std::result::Result<T, Error>;

/// Shuck error types.
#[derive(Debug, Clone)]
pub enum Error {
    /// Parse error occurred while parsing the script.
    ///
    /// When `line` and `column` are 0, the error has no source location.
    Parse {
        /// Human-readable error message.
        message: String,
        /// 1-based source line, or `0` when unknown.
        line: usize,
        /// 1-based source column, or `0` when unknown.
        column: usize,
    },
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let Self::Parse {
            message,
            line,
            column,
        } = self;
        if *line > 0 {
            write!(f, "parse error at line {line}, column {column}: {message}")
        } else {
            write!(f, "parse error: {message}")
        }
    }
}

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

impl Error {
    /// Create a parse error with source location.
    pub fn parse_at(message: impl Into<String>, line: usize, column: usize) -> Self {
        Self::Parse {
            message: message.into(),
            line,
            column,
        }
    }

    /// Create a parse error without source location.
    pub fn parse(message: impl Into<String>) -> Self {
        Self::Parse {
            message: message.into(),
            line: 0,
            column: 0,
        }
    }
}