steckrs 0.4.0

A lightweight, trait-based plugin system for Rust applications and libraries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

//! # Error Types
//!
//! This module provides error types for the [`steckrs`](crate) library.
//!
//! The error types in this module are used throughout the library to represent
//! various failure conditions that can occur during plugin management, hook
//! registration, and other operations.
//!
//! Error types are defined with help of the [`thiserror`] crate.
//!
//! ## Error Types
//!
//! - [`PluginError`]: Errors related to [Plugin](crate::Plugin) management
//! - [`HookError`]: Errors related to [hook](crate::hook::Hook) registration and management
//!
//! ## Result Types
//!
//! This module also provides type aliases for commonly used Result types:
//!
//! - [`PluginResult<T>`]: Results from plugin operations
//! - [`HookResult<T>`]: Results from hook operations

use crate::PluginIDOwned;

/// Result type for plugin operations
pub type HookResult<T> = Result<T, HookError>;

/// Result type for plugin operations
pub type PluginResult<T> = Result<T, PluginError>;

/// Error type for plugin-related operations.
///
/// These errors can occur during plugin loading, unloading, enabling,
/// disabling, or other plugin management operations.
#[derive(Debug, thiserror::Error)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum PluginError {
    /// A [Plugin](crate::Plugin) is already loaded
    #[error("{0} was already loaded")]
    AlreadyLoaded(PluginIDOwned),

    /// A [Plugin](crate::Plugin) was requested that is not registered
    #[error("Plugin not found: {0}")]
    NotFound(PluginIDOwned),

    /// Something went wrong when working with hooks
    #[error("Hook error: {0}")]
    HookError(#[from] HookError),
}

/// Error type for hook-related operations.
///
/// These errors can occur during hook registration, deregistration,
/// or other hook management operations.
#[derive(Debug, thiserror::Error)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum HookError {
    /// Indicates a hook with the same ID is already registered.
    #[error("Tried to register to a hook that already exists")]
    AlreadyRegistered,
}