libset 0.1.6

A configuration file management library for Rust applications.
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

use std::{fmt::Display, path::Path};

use tracing::error;

use crate::Error;

#[derive(Debug, Clone, Copy, PartialEq)]
pub enum FileType {
    Plain,
    #[cfg(feature = "toml")]
    Toml,
    #[cfg(feature = "json")]
    Json,
    #[cfg(feature = "ron")]
    Ron,
}

impl Display for FileType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            #[cfg(feature = "toml")]
            FileType::Toml => write!(f, "toml"),
            #[cfg(feature = "json")]
            FileType::Json => write!(f, "json"),
            #[cfg(feature = "ron")]
            FileType::Ron => write!(f, "ron"),
            FileType::Plain => write!(f, ""),
        }
    }
}

/// Check that the name is relative.
///
/// # Arguments
///
/// * `name` - The name to be sanitized
///
/// # Returns
///
/// Returns a `Result` containing a reference to the sanitized `Path` if the name is valid,
/// otherwise returns an `Error` indicating the invalid name.
pub(crate) fn sanitize_name(name: &str) -> Result<&Path, Error> {
    let path = Path::new(name);
    if path
        .components()
        .all(|x| matches!(x, std::path::Component::Normal(_)))
    {
        Ok(path)
    } else {
        let error = Error::InvalidName(name.to_owned());
        error!("{}", error.to_string());
        Err(error)
    }
}