ferroclass 0.12.0

Hierarchical inventory management tool (reclass compatible)
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

// SPDX-FileCopyrightText: 2026 Michael Jansen <ferroclass@michael-jansen.biz>
// SPDX-License-Identifier: MPL-2.0

//! File-system storage backends.
//!
//! Provides [`YamlFsRepository`] for the directory-tree layout (`nodes/`,
//! `classes/`, `_init.yml` autoloading) and [`YamlFileRepository`] for the
//! single-file layout.

use crate::parser::yaml;
use snafu::Snafu;
use std::string::FromUtf8Error;

mod classes_iterator;
mod iterator;
mod nodes_iterator;
mod repository;
mod yaml_file_repository;

use crate::inventory::elements::{class_parser, node_parser};
pub use repository::YamlFsRepository;
pub use yaml_file_repository::YamlFileRepository;

/// Errors that can occur while reading YAML files from a filesystem repository.
#[derive(Debug, Snafu)]
#[snafu(visibility(pub(in super::file_system)))]
pub enum Error {
    #[snafu(display("i/o error: {path}"))]
    Io {
        source: std::io::Error,
        path: String,
    },
    #[snafu(display("invalid yaml in {path}"))]
    Yaml { source: yaml::Error, path: String },
    #[snafu(display("invalid UTF-8 encoding in {path}"))]
    Encoding { source: FromUtf8Error, path: String },
    #[snafu(display("{message}: {path}"))]
    InvalidPath { message: String, path: String },
    #[snafu(display("file {path}"))]
    InvalidClassDefinition {
        source: class_parser::Error,
        path: String,
    },
    #[snafu(display("file {path}"))]
    InvalidNodeDefinition {
        source: node_parser::Error,
        path: String,
    },
}