Enum ModuleState

pub enum ModuleState {
    Active(Module),
    Cleared,
    FailedInit(ModuleInitError),
}

Represents the state of the module.

This enum implements an API to manage a single global variable of internally managed module (e.g. SkyrimSE.exe) information.

Variants

Active(Module)

The module is successfully initialized and active.

Cleared

The module instance has been explicitly cleared and memory has been freed.

FailedInit(ModuleInitError)

The module failed to initialize.

Implementations

impl ModuleState

pub fn map_active<F, T>(f: F) -> Result<T, ModuleStateError>

where F: FnOnce(&Module) -> T,

Attempts to apply a function to the active module state.

This function tries to acquire a read lock on the module state and applies the provided function f if the module state is ModuleState::Active.

If you do not know when you did the Self::reset, or if you want it to be reinitialized automatically if necessary, Self::map_or_init is useful.

Example

use commonlibsse_ng::rel::module::ModuleState;

let result = ModuleState::map_active(|module| module.version.clone());
match result {
    Ok(version) => println!("Module version: {}", version),
    Err(err) => eprintln!("Error: {:?}", err),
}

Errors

Returns an error if:

• The module state is ModuleState::Cleared.
• The module state is ModuleState::FailedInit, in which case the initialization error is propagated.
• The internal lock is poisoned.

pub fn map_or_init<F, T>(f: F) -> Result<T, ModuleStateError>

where F: FnOnce(&Module) -> T,

Attempts to apply a function to the active module state, initializing it if necessary.

If the module state is Cleared/FailedInit, it will be initialized before applying the function f. This function also attempts a read lock first and falls back to initialization only if needed.

Example

use commonlibsse_ng::rel::module::ModuleState;

let result = ModuleState::map_or_init(|module| module.version.clone());
match result {
    Ok(version) => println!("Module version: {}", version),
    Err(err) => eprintln!("Error: {:?}", err),
}

Errors

Returns an error if:

• The module state is ModuleState::FailedInit, in which case the initialization error is propagated.
• The internal lock is poisoned.

pub fn reset() -> Result<(), ModuleStateError>

Clears the module, transitioning it to the Cleared state.

Example

use commonlibsse_ng::rel::module::ModuleState;

assert!(ModuleState::reset().is_ok());

Errors

If the thread that had previously acquired a lock on the singleton instance panics, an error is returned.

Trait Implementations

impl Clone for ModuleState

fn clone(&self) -> ModuleState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModuleState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ModuleState

fn eq(&self, other: &ModuleState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ModuleState

impl StructuralPartialEq for ModuleState