mysql_handler/
license.rs

1// Copyright (C) 2026 ren-yamanashi
2//
3// This program is free software; you can redistribute it and/or modify
4// it under the terms of the GNU General Public License, version 2.0,
5// as published by the Free Software Foundation.
6//
7// This program is designed to work with certain software (including
8// but not limited to OpenSSL) that is licensed under separate terms,
9// as designated in a particular file or component or in included license
10// documentation. The authors of this program hereby grant you an additional
11// permission to link the program and your derivative works with the
12// separately licensed software that they have either included with
13// the program or referenced in the documentation.
14//
15// This program is distributed in the hope that it will be useful,
16// but WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18// GNU General Public License for more details.
19//
20// You should have received a copy of the GNU General Public License
21// along with this program; if not, see <https://www.gnu.org/licenses/>.
22
23//! License tag for the plugin manifest.
24
25use core::ffi::c_int;
26
27/// MySQL plugin license tag. The discriminant matches the
28/// `PLUGIN_LICENSE_*` constants in `include/mysql/plugin.h`, so the
29/// value can be embedded directly into the manifest's `license` field
30/// at compile time.
31#[derive(Debug, Clone, Copy, PartialEq, Eq)]
32#[non_exhaustive]
33pub enum License {
34    /// Closed-source license. Maps to `PLUGIN_LICENSE_PROPRIETARY` (0).
35    Proprietary,
36    /// GNU General Public License. Maps to `PLUGIN_LICENSE_GPL` (1).
37    Gpl,
38    /// BSD-style license. Maps to `PLUGIN_LICENSE_BSD` (2).
39    Bsd,
40}
41
42impl License {
43    /// Returns the wire-level `c_int` discriminant the MySQL plugin
44    /// manifest expects in its `license` field. `const` so the value
45    /// can be embedded in a `static` initialiser.
46    #[must_use]
47    pub const fn code(self) -> c_int {
48        match self {
49            License::Proprietary => 0,
50            License::Gpl => 1,
51            License::Bsd => 2,
52        }
53    }
54}
55
56#[cfg(test)]
57mod tests {
58    use super::License;
59
60    #[test]
61    fn code_matches_mysql_plugin_h_constants() {
62        assert_eq!(License::Proprietary.code(), 0);
63        assert_eq!(License::Gpl.code(), 1);
64        assert_eq!(License::Bsd.code(), 2);
65    }
66}
mysql_handler/license.rs

mysql_handler/
license.rs
