helpers4 0.0.6

General-purpose Rust helpers, one crate, one feature per module (string, array, ...)
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

// This file is part of helpers4.
// Copyright (C) 2025 baxyz
// SPDX-License-Identifier: LGPL-3.0-or-later

use super::Category;

/// What is known about one license: its SPDX identifier, its name and its family.
///
/// Get it with [`lookup`](super::lookup).
///
/// # Examples
///
/// ```
/// use helpers4::license::{lookup, Category};
///
/// let info = lookup("apache-2.0").unwrap();
/// assert_eq!(info.id(), "Apache-2.0");
/// assert_eq!(info.name(), "Apache License 2.0");
/// assert_eq!(info.category(), Category::Permissive);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct LicenseInfo {
    id: &'static str,
    name: &'static str,
    category: Category,
}

impl LicenseInfo {
    pub(crate) fn new(id: &'static str, name: &'static str, category: Category) -> Self {
        Self { id, name, category }
    }

    /// The SPDX identifier in its canonical case.
    ///
    /// # Returns
    ///
    /// For instance `"Apache-2.0"`.
    #[must_use]
    pub fn id(&self) -> &'static str {
        self.id
    }

    /// The full name of the license.
    ///
    /// # Returns
    ///
    /// For instance `"Apache License 2.0"`.
    #[must_use]
    pub fn name(&self) -> &'static str {
        self.name
    }

    /// The family the license belongs to.
    ///
    /// # Returns
    ///
    /// The [`Category`].
    #[must_use]
    pub fn category(&self) -> Category {
        self.category
    }
}

#[cfg(test)]
#[path = "license_info.test.rs"]
mod tests;