bp3d_os/module/library/
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 contains various library types.
30
31mod symbol;
32pub mod types;
33#[cfg(unix)]
34mod unix;
35mod r#virtual;
36#[cfg(windows)]
37mod windows;
38
39/// The extension of a module.
40#[cfg(unix)]
41pub const OS_EXT: &str = unix::EXT;
42
43/// The extension of a module.
44#[cfg(windows)]
45pub const OS_EXT: &str = windows::EXT;
46
47/// Represents a library.
48pub trait Library {
49    /// Attempts to load the given symbol from this library.
50    ///
51    /// # Arguments
52    ///
53    /// * `name`: the name of the symbol.
54    ///
55    /// returns: Result<Symbol<T>, Error>
56    ///
57    /// # Safety
58    ///
59    /// This function assumes the returned symbol is of the correct type and does not use any ABI
60    /// incompatible types. If this condition is not maintained then this function is UB.
61    unsafe fn load_symbol<T>(
62        &self,
63        name: impl AsRef<str>,
64    ) -> crate::module::Result<Option<types::Symbol<'_, T>>>;
65}