masterror 0.32.0

Application error types and response mapping
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

// SPDX-FileCopyrightText: 2025 RAprogramm <andrey.rozanov.vl@gmail.com>
//
// SPDX-License-Identifier: MIT

//! Data structures for README metadata and configuration.
//!
//! Defines all types used for parsing Cargo.toml metadata and
//! representing feature documentation.

use std::collections::BTreeMap;

use serde::Deserialize;

/// Cargo.toml manifest structure.
#[derive(Debug, Deserialize)]
pub struct Manifest {
    pub(crate) package:   Package,
    #[serde(default)]
    pub(crate) features:  BTreeMap<String, Vec<String>>,
    #[serde(default)]
    pub(crate) workspace: Option<Workspace>
}

/// Package section of Cargo.toml.
#[derive(Debug, Deserialize)]
pub struct Package {
    pub(crate) version:      String,
    #[serde(rename = "rust-version")]
    pub(crate) rust_version: Option<RustVersion>,
    #[serde(default)]
    pub(crate) metadata:     Option<PackageMetadata>
}

/// The `rust-version` field of a package.
///
/// The field holds either a literal version or a workspace inheritance.
///
/// # Examples
///
/// ```toml
/// rust-version = "1.99"
/// rust-version.workspace = true
/// ```
#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum RustVersion {
    Value(String),
    Inherited { workspace: bool }
}

/// Workspace section of Cargo.toml.
#[derive(Debug, Deserialize)]
pub struct Workspace {
    #[serde(default)]
    pub(crate) package: Option<WorkspacePackage>
}

/// Workspace package defaults.
#[derive(Debug, Deserialize)]
pub struct WorkspacePackage {
    #[serde(rename = "rust-version")]
    pub(crate) rust_version: Option<String>
}

/// Package metadata section.
#[derive(Debug, Deserialize)]
pub struct PackageMetadata {
    #[serde(default)]
    pub(crate) masterror: Option<MasterrorMetadata>
}

/// Masterror-specific metadata.
#[derive(Debug, Deserialize)]
pub struct MasterrorMetadata {
    #[serde(default)]
    pub(crate) readme: Option<ReadmeMetadata>
}

/// README generation metadata configuration.
#[derive(Clone, Debug, Deserialize)]
pub struct ReadmeMetadata {
    #[serde(default)]
    pub(crate) feature_order:         Vec<String>,
    #[serde(default)]
    pub(crate) feature_snippet_group: Option<usize>,
    #[serde(default)]
    pub(crate) conversion_lines:      Vec<String>,
    #[serde(default)]
    pub(crate) features:              BTreeMap<String, FeatureMetadata>
}

/// Metadata for a single feature.
#[derive(Clone, Debug, Deserialize)]
pub struct FeatureMetadata {
    pub(crate) description: String,
    #[serde(default)]
    pub(crate) extra:       Vec<String>
}

/// Processed feature documentation.
#[derive(Clone, Debug)]
pub struct FeatureDoc {
    pub(crate) name:        String,
    pub(crate) description: String,
    pub(crate) extra:       Vec<String>
}