plceye 0.7.1

PLC code smell detector and static analyzer for L5X and PLCopen 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

//! Error types for the rule detector.

use thiserror::Error;

/// Result type alias for rule operations.
pub type Result<T> = std::result::Result<T, Error>;

/// Error types for the rule detector.
#[derive(Debug, Error)]
pub enum Error {
    /// Failed to read file
    #[error("Failed to read file '{path}': {source}")]
    FileRead {
        path: String,
        #[source]
        source: std::io::Error,
    },

    /// Failed to parse L5X file
    #[error("Failed to parse L5X file: {kind}")]
    L5xParse {
        kind: L5xParseErrorKind,
    },

    /// Failed to parse config file
    #[error("Failed to parse config file: {kind}")]
    ConfigParse {
        kind: ConfigErrorKind,
    },
}

/// Kinds of L5X parse errors.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum L5xParseErrorKind {
    /// XML deserialization failed
    XmlDeserialize,
    /// Missing required element
    MissingElement(&'static str),
}

impl std::fmt::Display for L5xParseErrorKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            L5xParseErrorKind::XmlDeserialize => write!(f, "XML deserialization failed"),
            L5xParseErrorKind::MissingElement(elem) => write!(f, "missing required element: {}", elem),
        }
    }
}

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

/// Kinds of configuration errors.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ConfigErrorKind {
    /// TOML syntax error
    TomlSyntax,
}

impl std::fmt::Display for ConfigErrorKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ConfigErrorKind::TomlSyntax => write!(f, "TOML syntax error"),
        }
    }
}

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