buffrs 0.13.2

Modern protobuf package 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
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

// NOTE: `PackagesError` fields are allowed unused as they are only used for err formatting
#![allow(unused_assignments)]

// Copyright 2023 Helsing GmbH
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use super::*;

/// Packages that make up a protocol buffer package.
#[derive(Serialize, Deserialize, Default, Clone, Debug, PartialEq, Eq, Diff)]
#[diff(attr(
    #[derive(Debug)]
    #[allow(missing_docs)]
))]
pub struct Packages {
    /// Packages defined in this protocol buffer package.
    pub packages: BTreeMap<String, Package>,
}

/// Error parsing packages.
#[derive(Error, Debug, Diagnostic)]
#[allow(missing_docs)]
pub enum PackagesError {
    #[error("error parsing package {package} in {file}")]
    PackageParse {
        package: String,
        file: String,
        #[source]
        #[diagnostic_source]
        error: PackageError,
    },
    #[error("internal data structure error occurred")]
    Internal,
}

impl Packages {
    /// Add a package from a [`FileDescriptorProto`].
    pub fn add(&mut self, descriptor: &FileDescriptorProto) -> Result<(), PackagesError> {
        let name = descriptor.package().to_string();

        let Some(package) = self.packages.get_mut(&name) else {
            let package =
                Package::new(descriptor).map_err(|error| PackagesError::PackageParse {
                    package: descriptor.package().to_string(),
                    file: descriptor.name().to_string(),
                    error,
                })?;

            self.packages.insert(name, package);

            return Ok(());
        };

        package
            .add(descriptor)
            .map_err(|_| PackagesError::Internal)?;

        Ok(())
    }

    /// Run checks against this.
    pub fn check(&self, rules: &mut RuleSet) -> Violations {
        let mut violations = rules.check_packages(self);
        for package in self.packages.values() {
            violations.append(&mut package.check(rules));
        }
        violations
    }
}