Struct ModuleLoader

pub struct ModuleLoader<T, O> { /* private fields */ }

A module loader.

Implementations

impl<'a, T, O> ModuleLoader<T, O>

where T: ModuleLoaderAPI<'a>, O: AccessIdentifier,

pub fn to_interface(&self) -> NonNullConst<ModuleLoaderInterface>

Fetches a pointer that can be used with the interface.

pub unsafe fn from_interface( loader: NonNullConst<ModuleLoaderInterface>, ) -> Self

Construct a new instance from a pointer.

Safety

This function should not be used directly.

pub unsafe fn from_void_ptr(handler: NonNullConst<c_void>) -> Self

Construct a new instance from a void pointer.

Safety

This function should not be used directly.

impl<'a, T, O> ModuleLoader<T, O>

where T: ModuleLoaderAPI<'a>, O: MutableAccessIdentifier,

pub unsafe fn add_module( &mut self, path: &impl AsRef<Path>, ) -> Result<InternalModule<Owned>, Error>

Adds a new module.

Failure

Fails if path is invalid or the type of the module can not be loaded with the loader.

Return

Module handle on success, error otherwise.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn remove_module( &mut self, module: InternalModule<Owned>, ) -> Result<(), Error>

Removes a module.

Failure

Fails if handle is invalid or the module is not in an unloaded state.

Return

Error on failure.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn load<MO>( &mut self, module: &mut InternalModule<MO>, ) -> Result<(), Error>

where MO: MutableAccessIdentifier,

Loads a module.

Failure

Fails if handle is invalid, the load dependencies of the module are not exported or the module is not in an unloaded state.

Return

Error on failure.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn unload<MO>( &mut self, module: &mut InternalModule<MO>, ) -> Result<(), Error>

where MO: MutableAccessIdentifier,

Unloads a module.

Failure

Fails if handle is invalid or the module is in an unloaded or ready state.

Return

Error on failure.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn initialize<MO>( &mut self, module: &mut InternalModule<MO>, ) -> Result<(), Error>

where MO: MutableAccessIdentifier,

Initializes a module.

Failure

Fails if handle is invalid, the runtime dependencies of the module are not exported or the module is not in a loaded state.

Return

Error on failure.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn terminate<MO>( &mut self, module: &mut InternalModule<MO>, ) -> Result<(), Error>

where MO: MutableAccessIdentifier,

Terminates a module.

Failure

Fails if handle is invalid or the module is not in a ready state.

Return

Error on failure.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

impl<'a, T, O> ModuleLoader<T, O>

where T: ModuleLoaderAPI<'a>, O: ImmutableAccessIdentifier,

pub unsafe fn fetch_status<MO>( &self, module: &InternalModule<MO>, ) -> Result<ModuleStatus, Error>

where MO: ImmutableAccessIdentifier,

Fetches the load status of a module.

Failure

Fails if handle is invalid.

Return

Module status on success, error otherwise.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn get_interface<'module, MO, IT>( &self, module: &'module InternalModule<MO>, interface: &InterfaceDescriptor, caster: impl FnOnce(Interface) -> IT, ) -> Result<Interface<'module, IT>, Error>

where MO: ImmutableAccessIdentifier,

Fetches an interface from a module.

Failure

Fails if handle is invalid, the module is not in a ready state or the interface is not contained in the module.

Return

Interface on success, error otherwise.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn get_module_info<'module, MO>( &self, module: &'module InternalModule<MO>, ) -> Result<&'module ModuleInfo, Error>

where MO: ImmutableAccessIdentifier,

Fetches the module info from a module.

Failure

Fails if handle is invalid or the module is not yet loaded.

Return

Module info on success, error otherwise.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn get_module_path<'module, MO>( &self, module: &'module InternalModule<MO>, ) -> Result<&'module [OSPathChar], Error>

where MO: ImmutableAccessIdentifier,

Fetches the path a module was loaded from.

The resulting slice is terminated with a \0 character.

Failure

Fails if handle is invalid or the module is not yet loaded.

Return

Module path on success, error otherwise.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn get_load_dependencies<'module, MO>( &self, module: &'module InternalModule<MO>, ) -> Result<&'module [InterfaceDescriptor], Error>

where MO: ImmutableAccessIdentifier,

Fetches the load dependencies of a module.

Failure

Fails if handle is invalid.

Return

Load dependencies on success, error otherwise.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn get_runtime_dependencies<'module, MO>( &self, module: &'module InternalModule<MO>, ) -> Result<&'module [InterfaceDescriptor], Error>

where MO: ImmutableAccessIdentifier,

Fetches the runtime dependencies of a module.

Failure

Fails if handle is invalid or the module is not yet loaded.

Return

Runtime dependencies on success, error otherwise.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn get_exportable_interfaces<'module, MO>( &self, module: &'module InternalModule<MO>, ) -> Result<&'module [InterfaceDescriptor], Error>

where MO: ImmutableAccessIdentifier,

Fetches the exportable interfaces of a module.

Failure

Fails if handle is invalid or the module is not yet loaded.

Return

Exportable interfaces on success, error otherwise.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

pub unsafe fn get_internal_interface( &self, ) -> ModuleLoader<T::InternalLoader, O>

Fetches a pointer to the internal loader interface.

Return

Pointer to the loader interface.

Safety

The function crosses the ffi boundary. Direct usage of a ModuleLoader may break some invariants of the module api, if not handled with care.

Trait Implementations

impl<T: Clone, O: Clone> Clone for ModuleLoader<T, O>

fn clone(&self) -> ModuleLoader<T, O>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, O: Debug> Debug for ModuleLoader<T, O>

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

Formats the value using the given formatter.

impl<'a, T, O> Deref for ModuleLoader<T, O>

where T: ModuleLoaderAPI<'a>, O: AccessIdentifier,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T, O> DerefMut for ModuleLoader<T, O>

where T: ModuleLoaderAPI<'a>, O: MutableAccessIdentifier,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Ord, O: Ord> Ord for ModuleLoader<T, O>

fn cmp(&self, other: &ModuleLoader<T, O>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, O: PartialEq> PartialEq for ModuleLoader<T, O>

fn eq(&self, other: &ModuleLoader<T, O>) -> 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<T: PartialOrd, O: PartialOrd> PartialOrd for ModuleLoader<T, O>

fn partial_cmp(&self, other: &ModuleLoader<T, O>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy, O: Copy> Copy for ModuleLoader<T, O>

impl<T: Eq, O: Eq> Eq for ModuleLoader<T, O>

impl<T, O> StructuralPartialEq for ModuleLoader<T, O>