Struct emf_core_base_rs::module::module_loader::ModuleLoader [−][src]
pub struct ModuleLoader<T, O> { /* fields omitted */ }
A module loader.
Implementations
impl<'a, T, O> ModuleLoader<T, O> where
T: ModuleLoaderAPI<'a>,
O: AccessIdentifier,
[src]
impl<'a, T, O> ModuleLoader<T, O> where
T: ModuleLoaderAPI<'a>,
O: AccessIdentifier,
[src]pub fn to_interface(&self) -> NonNullConst<ModuleLoaderInterface>
[src]
Fetches a pointer that can be used with the interface.
pub unsafe fn from_interface(
loader: NonNullConst<ModuleLoaderInterface>
) -> Self
[src]
loader: NonNullConst<ModuleLoaderInterface>
) -> Self
pub unsafe fn from_void_ptr(handler: NonNullConst<c_void>) -> Self
[src]
impl<'a, T, O> ModuleLoader<T, O> where
T: ModuleLoaderAPI<'a>,
O: MutableAccessIdentifier,
[src]
impl<'a, T, O> ModuleLoader<T, O> where
T: ModuleLoaderAPI<'a>,
O: MutableAccessIdentifier,
[src]pub unsafe fn add_module(
&mut self,
path: &impl AsRef<Path>
) -> Result<InternalModule<Owned>, Error>
[src]
&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>
[src]
&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,
[src]
&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,
[src]
&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,
[src]
&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,
[src]
&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,
[src]
impl<'a, T, O> ModuleLoader<T, O> where
T: ModuleLoaderAPI<'a>,
O: ImmutableAccessIdentifier,
[src]pub unsafe fn fetch_status<MO>(
&self,
module: &InternalModule<MO>
) -> Result<ModuleStatus, Error> where
MO: ImmutableAccessIdentifier,
[src]
&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,
[src]
&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,
[src]
&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,
[src]
&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,
[src]
&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,
[src]
&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,
[src]
&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>
[src]
&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>
[src]
impl<T: Clone, O: Clone> Clone for ModuleLoader<T, O>
[src]fn clone(&self) -> ModuleLoader<T, O>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Copy, O: Copy> Copy for ModuleLoader<T, O>
[src]
impl<T: Copy, O: Copy> Copy for ModuleLoader<T, O>
[src]impl<T: Debug, O: Debug> Debug for ModuleLoader<T, O>
[src]
impl<T: Debug, O: Debug> Debug for ModuleLoader<T, O>
[src]impl<'a, T, O> Deref for ModuleLoader<T, O> where
T: ModuleLoaderAPI<'a>,
O: AccessIdentifier,
[src]
impl<'a, T, O> Deref for ModuleLoader<T, O> where
T: ModuleLoaderAPI<'a>,
O: AccessIdentifier,
[src]impl<'a, T, O> DerefMut for ModuleLoader<T, O> where
T: ModuleLoaderAPI<'a>,
O: MutableAccessIdentifier,
[src]
impl<'a, T, O> DerefMut for ModuleLoader<T, O> where
T: ModuleLoaderAPI<'a>,
O: MutableAccessIdentifier,
[src]impl<T: Eq, O: Eq> Eq for ModuleLoader<T, O>
[src]
impl<T: Eq, O: Eq> Eq for ModuleLoader<T, O>
[src]impl<T: Ord, O: Ord> Ord for ModuleLoader<T, O>
[src]
impl<T: Ord, O: Ord> Ord for ModuleLoader<T, O>
[src]impl<T: PartialEq, O: PartialEq> PartialEq<ModuleLoader<T, O>> for ModuleLoader<T, O>
[src]
impl<T: PartialEq, O: PartialEq> PartialEq<ModuleLoader<T, O>> for ModuleLoader<T, O>
[src]fn eq(&self, other: &ModuleLoader<T, O>) -> bool
[src]
fn ne(&self, other: &ModuleLoader<T, O>) -> bool
[src]
impl<T: PartialOrd, O: PartialOrd> PartialOrd<ModuleLoader<T, O>> for ModuleLoader<T, O>
[src]
impl<T: PartialOrd, O: PartialOrd> PartialOrd<ModuleLoader<T, O>> for ModuleLoader<T, O>
[src]fn partial_cmp(&self, other: &ModuleLoader<T, O>) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<T, O> StructuralEq for ModuleLoader<T, O>
[src]
impl<T, O> StructuralEq for ModuleLoader<T, O>
[src]impl<T, O> StructuralPartialEq for ModuleLoader<T, O>
[src]
impl<T, O> StructuralPartialEq for ModuleLoader<T, O>
[src]Auto Trait Implementations
impl<T, O> RefUnwindSafe for ModuleLoader<T, O> where
O: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, O> RefUnwindSafe for ModuleLoader<T, O> where
O: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, O> !Send for ModuleLoader<T, O>
impl<T, O> !Send for ModuleLoader<T, O>
impl<T, O> !Sync for ModuleLoader<T, O>
impl<T, O> !Sync for ModuleLoader<T, O>
impl<T, O> Unpin for ModuleLoader<T, O> where
T: Unpin,
impl<T, O> Unpin for ModuleLoader<T, O> where
T: Unpin,
impl<T, O> UnwindSafe for ModuleLoader<T, O> where
O: RefUnwindSafe,
T: UnwindSafe,
impl<T, O> UnwindSafe for ModuleLoader<T, O> where
O: RefUnwindSafe,
T: UnwindSafe,