arbor-core 2.0.0

AST parsing and code analysis for Arbor
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

//! Error types for the parsing module.
//!
//! We keep errors simple and actionable. Each variant tells you
//! exactly what went wrong and (usually) how to fix it.

use std::path::PathBuf;
use thiserror::Error;

/// Convenience type for functions that can fail during parsing.
pub type Result<T> = std::result::Result<T, ParseError>;

/// Things that can go wrong when parsing source files.
#[derive(Error, Debug)]
pub enum ParseError {
    /// Couldn't read the file from disk.
    #[error("failed to read file '{path}': {source}")]
    IoError {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },

    /// File extension doesn't map to any supported language.
    #[error("unsupported language for file '{0}'")]
    UnsupportedLanguage(PathBuf),

    /// Tree-sitter failed to parse the source. Usually means
    /// the file has syntax errors or the parser hit an edge case.
    #[error("parser error: {0}")]
    ParserError(String),

    /// Tree-sitter query compilation failed. Usually means
    /// the query pattern is invalid for the language grammar.
    #[error("query error: {0}")]
    QueryError(String),

    /// The file exists but is empty. Not really an error,
    /// but we surface it so callers can handle it gracefully.
    #[error("file is empty: '{0}'")]
    EmptyFile(PathBuf),
}

impl ParseError {
    /// Creates an IO error with the path for context.
    pub fn io(path: impl Into<PathBuf>, source: std::io::Error) -> Self {
        Self::IoError {
            path: path.into(),
            source,
        }
    }
}