bp3d_os/module/
module.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
29use crate::module::library::Library;
30use crate::module::metadata::Metadata;
31use std::fmt::{Debug, Display, Formatter};
32
33/// This represents a module shared object.
34#[derive(Debug)]
35pub struct Module<L> {
36    lib: L,
37    metadata: Metadata,
38    pub(super) id: usize,
39    pub(super) ref_count: usize,
40}
41
42impl<L> Display for Module<L> {
43    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
44        self.metadata.fmt(f)
45    }
46}
47
48impl<L: Library> Module<L> {
49    /// Constructs a new [Module] from an existing [Library] handle.
50    ///
51    /// # Arguments
52    ///
53    /// * `lib`: the library to wrap.
54    /// * `metadata`: module metadata.
55    ///
56    /// returns: Module
57    pub fn new(lib: L, metadata: Metadata) -> Self {
58        Module {
59            lib,
60            metadata,
61            id: 0,
62            ref_count: 1,
63        }
64    }
65
66    /// Gets a metadata key by its name.
67    ///
68    /// # Arguments
69    ///
70    /// * `key`: the key to read from the metadata (ex: NAME).
71    ///
72    /// returns: Option<&str>
73    pub fn get_metadata_key(&self, key: &str) -> Option<&str> {
74        self.metadata.get(key).map(|s| s.as_str())
75    }
76
77    /// Returns the library attached to this module.
78    pub fn lib(&self) -> &L {
79        &self.lib
80    }
81}
bp3d_os/module/module.rs

bp3d_os/module/
module.rs
