Struct emf_core_base_rs::library::library_loader::LibraryLoader

pub struct LibraryLoader<T, O> { /* fields omitted */ }

A library loader.

Implementations

impl<'a, T, O> LibraryLoader<T, O> where
    T: LibraryLoaderAPI<'a>,
    O: AccessIdentifier, 

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

Fetches a pointer that can be used with the interface.

pub unsafe fn from_interface(
    handler: NonNullConst<LibraryLoaderInterface>
) -> 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> LibraryLoader<T, O> where
    T: LibraryLoaderAPI<'a>,
    O: MutableAccessIdentifier, 

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

Loads a library. The resulting handle is unique.

Failure

The function fails if loader or path is invalid or the type of the library can not be loaded with the loader.

Return

Handle on success, error otherwise.

Safety

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

pub unsafe fn unload(
    &mut self,
    internal: InternalLibrary<Owned>
) -> Result<(), Error>

Unloads a library.

Failure

The function fails if internal is invalid.

Return

Error on failure.

Safety

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

impl<'a, T, O> LibraryLoader<T, O> where
    T: LibraryLoaderAPI<'a>,
    O: ImmutableAccessIdentifier, 

pub unsafe fn get_data_symbol<LO, U>(
    &self,
    internal: &InternalLibrary<LO>,
    symbol: &impl AsRef<CStr>,
    caster: impl FnOnce(NonNullConst<c_void>) -> &'a U
) -> Result<Symbol<'a, &'a U>, Error> where
    LO: ImmutableAccessIdentifier, 

Fetches a data symbol from a library.

Failure

The function fails if internal is invalid or library does not contain symbol.

Note

Some platforms may differentiate between a function-pointer and a data-pointer. See LibraryLoader::get_function_symbol() for fetching a function.

Return

Symbol on success, error otherwise.

Safety

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

pub unsafe fn get_function_symbol<LO, U>(
    &self,
    internal: &InternalLibrary<LO>,
    symbol: &impl AsRef<CStr>,
    caster: impl FnOnce(CBaseFn) -> U
) -> Result<Symbol<'a, U>, Error> where
    LO: ImmutableAccessIdentifier, 

Fetches a function symbol from a library.

Failure

The function fails if internal is invalid or library does not contain symbol.

Note

Some platforms may differentiate between a function-pointer and a data-pointer. See LibraryLoader::get_data_symbol() for fetching some data.

Return

Symbol on success, error otherwise.

Safety

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

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

Fetches a pointer to the internal interface.

Return

Pointer to the interface.

Safety

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

impl<'a, T, O> Deref for LibraryLoader<T, O> where
    T: LibraryLoaderAPI<'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 LibraryLoader<T, O> where
    T: LibraryLoaderAPI<'a>,
    O: MutableAccessIdentifier, 

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

Mutably dereferences the value.

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

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

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

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

fn eq(&self, other: &LibraryLoader<T, O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LibraryLoader<T, O>) -> bool

This method tests for !=.

impl<T: PartialOrd, O: PartialOrd> PartialOrd<LibraryLoader<T, O>> for LibraryLoader<T, O>

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl<T, O> StructuralEq for LibraryLoader<T, O>

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