plugx-config 0.3.0

Plugin configuration management
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

//! Configuration parser trait and implementations.

use plugx_input::Input;
use std::fmt::{Debug, Display};
use thiserror::Error;

#[cfg(feature = "env")]
pub mod env;
#[cfg(feature = "json")]
pub mod json;
#[cfg(feature = "toml")]
pub mod toml;
#[cfg(feature = "yaml")]
pub mod yaml;

pub mod closure;

/// Parser error type.
#[derive(Debug, Error)]
pub enum Error {
    /// Could not parse contents.
    #[error("{parser} with supported formats {supported_format_list:?} could not parse `{data}`")]
    Parse {
        data: String,
        parser: String,
        supported_format_list: Vec<String>,
        source: anyhow::Error,
    },
    /// Could not find parser or guess format to choose correct parser.
    #[error("Could not found parser to parse format `{format}`")]
    ParserNotFound { format: String },
}

/// A trait to parse configuration contents.
pub trait Parser: Send + Sync + Debug + Display {
    /// Supported format list (e.g. "yml")
    fn supported_format_list(&self) -> Vec<String>;

    /// Parses a byte slice to [Input].
    fn try_parse(&self, bytes: &[u8]) -> anyhow::Result<Input>;

    /// Checks if provided byte slice is ok for future parsing. (e.g. is it YAML at all or not)
    fn is_format_supported(&self, bytes: &[u8]) -> Option<bool>;

    fn parse(&self, bytes: &[u8]) -> Result<Input, Error> {
        self.try_parse(bytes).map_err(|source| Error::Parse {
            data: String::from_utf8_lossy(bytes).to_string(),
            parser: format!("{self}"),
            supported_format_list: self.supported_format_list(),
            source,
        })
    }
}