cfgmatic-files 2.2.0

Configuration file discovery and reading with multiple format support
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

//! Error types for file operations.

use std::path::PathBuf;

/// Errors that can occur when working with configuration files.
#[derive(Debug, thiserror::Error)]
pub enum FileError {
    /// IO error occurred.
    #[error("io error: {0}")]
    Io(#[from] std::io::Error),

    /// File not found in any search location.
    #[error("config file not found: searched in {locations}")]
    NotFound {
        /// The file pattern that was searched for.
        pattern: String,
        /// Locations that were searched.
        locations: String,
    },

    /// Parse error for a specific format.
    #[error("failed to parse {format} file at {path}: {source}")]
    Parse {
        /// Path to the file.
        path: PathBuf,
        /// Format that failed to parse.
        format: &'static str,
        /// Original error.
        source: Box<dyn std::error::Error + Send + Sync>,
    },

    /// Format not supported (feature not enabled).
    #[error("format '{format}' not supported (feature not enabled)")]
    UnsupportedFormat {
        /// The unsupported format.
        format: String,
    },

    /// Serialization error.
    #[error("serialization error: {0}")]
    Serialization(String),
}

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