bp3d_os/module/
metadata.rs

1// Copyright (c) 2025, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29//! Utilities around module metadata.
30
31use crate::module::error::Error;
32use std::collections::HashMap;
33
34/// The metadata map type.
35pub type Metadata = HashMap<String, Value>;
36
37/// A wrapper for a metadata value with utility methods.
38#[derive(Debug, Eq, PartialEq)]
39pub struct Value(String);
40
41impl Value {
42    /// Creates a new instance of metadata value.
43    pub fn new(value: String) -> Value {
44        Value(value)
45    }
46
47    /// Returns the underlying string content.
48    pub fn as_str(&self) -> &str {
49        &self.0
50    }
51
52    /// Returns the len of this [Value].
53    pub fn len(&self) -> usize {
54        self.0.len()
55    }
56
57    /// Returns true if this [Value] is empty.
58    pub fn is_empty(&self) -> bool {
59        self.0.is_empty()
60    }
61
62    /// Assumes this [Value] is a list and return an iterator over it.
63    pub fn as_list(&self) -> Option<impl Iterator<Item = &str>> {
64        // Amazingly broken split function that cannot figure out that empty strings should be
65        // ignored...
66        if self.0.is_empty() {
67            None
68        } else {
69            Some(self.as_str().split(','))
70        }
71    }
72
73    /// Assumes this [Value] is a list of key value pairs and return an iterator over it.
74    pub fn parse_key_value_pairs(
75        &self,
76    ) -> Option<impl Iterator<Item = super::Result<(String, &str)>>> {
77        Some(self.as_list()?.map(|item| {
78            let mut iter = item.split("=");
79            let name = iter
80                .next()
81                .ok_or(Error::InvalidDepFormat)?
82                .replace("-", "_");
83            let version = iter.next().ok_or(Error::InvalidDepFormat)?;
84            Ok((name, version))
85        }))
86    }
87}
bp3d_os/module/metadata.rs

bp3d_os/module/
metadata.rs
