potenv 0.2.0

Rust implementation of the POSIX-compliant dotenv file format specification.
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

use std::path::{Path, PathBuf};

use thiserror::Error;

use super::pos::Position;

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ErrorKind {
    Eof,
    NullCharacter,
    UnescapedSpecialCharacter(char),
    UnterminatedSingleQuotedString,
    UnterminatedDoubleQuotedString,
    UnsupportedShellParameter(String),
    UnterminatedExpansion,
    UnsupportedCommandExpansion,
    UnsupportedCommandOrArithmeticExpansion,
    InvalidCharacter(char),
}

impl std::fmt::Display for ErrorKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Eof => write!(f, "Unexpected end of input"),
            Self::NullCharacter => write!(f, "Unexpected <NUL> character"),
            Self::UnescapedSpecialCharacter(ch) => {
                write!(f, "Unescaped special shell character '{ch}'")
            }
            Self::UnterminatedSingleQuotedString => {
                write!(f, "Unterminated single-quoted string")
            }
            Self::UnterminatedDoubleQuotedString => {
                write!(f, "Unterminated double-quoted string")
            }
            Self::UnsupportedShellParameter(p) => {
                write!(f, "Unsupported special shell parameter: {p}")
            }
            Self::UnterminatedExpansion => write!(f, "Unterminated expansion"),
            Self::UnsupportedCommandExpansion => write!(f, "Unsupported command expansion"),
            Self::UnsupportedCommandOrArithmeticExpansion => {
                write!(f, "Unsupported command or arithmetic expansion")
            }
            Self::InvalidCharacter(ch) => write!(f, "Invalid character '{ch}'"),
        }
    }
}

#[derive(Error, Debug, PartialEq, Eq)]
pub struct SyntaxError {
    kind: ErrorKind,
    position: Position,
    filename: Option<PathBuf>,
}

impl std::fmt::Display for SyntaxError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.kind().fmt(f)?;
        if let Some(file) = self.file() {
            write!(f, " in {}", file.display())?;
        }
        write!(f, " on line {}, column {}", self.line(), self.column())
    }
}

impl SyntaxError {
    pub fn new(kind: ErrorKind, position: Position, filename: Option<PathBuf>) -> Self {
        Self {
            kind,
            position,
            filename,
        }
    }

    pub fn kind(&self) -> &ErrorKind {
        &self.kind
    }

    pub fn line(&self) -> usize {
        self.position.line
    }

    pub fn column(&self) -> usize {
        self.position.column
    }

    pub fn file(&self) -> Option<&Path> {
        self.filename.as_deref()
    }
}