bp3d_os/module/
mod.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//! This module provides tools to load symbols from external libraries/plugins.
30
31/// The rustc version being used (note this version includes the null terminator for simplified
32/// generation.
33pub const RUSTC_VERSION: &str = env!("RUSTC_VERSION");
34
35/// The type of result when managing module.
36pub type Result<T> = std::result::Result<T, error::Error>;
37
38pub mod error;
39
40pub mod loader;
41
42#[allow(clippy::module_inception)]
43mod module;
44
45pub mod library;
46
47pub mod metadata;
48
49pub use module::Module;
50
51/// Link the set of modules statically.
52///
53/// Note: the modules must be available as Cargo dependencies.
54#[macro_export]
55macro_rules! link_modules {
56    ($($module: ident),*) => {
57        #[used]
58        static BUILTIN_MODULES: &'static [&'static $crate::module::library::types::VirtualLibrary] = &[
59            $(&$module::VIRTUAL_MODULE),*
60        ];
61    };
62}
bp3d_os/module/mod.rs

bp3d_os/module/
mod.rs
