dynamic_plugin/
lib.rs

1#![deny(missing_docs)]
2#![warn(clippy::pedantic)]
3#![doc = include_str!("../README.md")]
4
5// Re-export macros
6pub use dynamic_plugin_macros::*;
7pub use const_format::concatcp as const_concat;
8
9// Re-export libloading library
10pub use libloading::Library as PluginDynamicLibrary;
11pub use libloading::Symbol as PluginLibrarySymbol;
12
13/// Re-exported libc types for convenience.
14pub use libc;
15
16/// The result type returned by dynamic plugin functions.
17pub type Result<T> = std::result::Result<T, Error>;
18
19/// Errors returned from dynamic plugin functions.
20#[derive(Debug, thiserror::Error)]
21pub enum Error {
22    /// An error returned from libloading when trying to communicate with the dynamic library.
23    #[error("An error while calling the plugin library: {0}")]
24    DynamicLibrary(#[from] libloading::Error),
25
26    /// The discovered library is not a plugin, as in it does not expose the `_dynamic_plugin_signature` function.
27    #[error("The discovered library is not a plugin.")]
28    NotAPlugin,
29
30    /// The plugin's signature (i.e. name, function names, function arguments and function return types) does not match the expected value.
31    #[error("The plugin's signature does not match.")]
32    InvalidPluginSignature,
33}
34
35/// Statically assert an expression with an error message.
36/// 
37/// This is used internally by the dynamic-plugin macros.
38#[macro_export]
39macro_rules! static_assert {
40    ($exp:expr, $msg:expr) => {
41        #[deny(const_err)]
42        #[allow(unused_must_use)]
43        const _: () = {
44            if !($exp) {
45                core::panic!("{}", $msg);
46            }
47
48            ()
49        };
50    };
51}
dynamic_plugin/lib.rs

dynamic_plugin/
lib.rs
