libloading

Struct Symbol

source
pub struct Symbol<'lib, T: 'lib> { /* private fields */ }
Expand description

Symbol from a library.

This type is a safeguard against using dynamically loaded symbols after a Library is unloaded. The primary method to create an instance of a Symbol is via Library::get.

The Deref trait implementation allows the use of Symbol as if it was a function or variable itself, without taking care to “extract” the function or variable manually most of the time.

Implementations§

source§

impl<'lib, T> Symbol<'lib, T>

source

pub unsafe fn into_raw(self) -> Symbol<T>

Extract the wrapped os::platform::Symbol.

§Safety

Using this function relinquishes all the lifetime guarantees. It is up to the developer to ensure the resulting Symbol is not used past the lifetime of the Library this symbol was loaded from.

§Examples
unsafe {
    let lib = Library::new("/path/to/awesome.module").unwrap();
    let symbol: Symbol<*mut u32> = lib.get(b"symbol\0").unwrap();
    let symbol = symbol.into_raw();
}
source

pub unsafe fn from_raw<L>(sym: Symbol<T>, library: &'lib L) -> Symbol<'lib, T>

Wrap the os::platform::Symbol into this safe wrapper.

Note that, in order to create association between the symbol and the library this symbol came from, this function requires a reference to the library.

§Safety

The library reference must be exactly the library sym was loaded from.

§Examples
unsafe {
    let lib = Library::new("/path/to/awesome.module").unwrap();
    let symbol: Symbol<*mut u32> = lib.get(b"symbol\0").unwrap();
    let symbol = symbol.into_raw();
    let symbol = Symbol::from_raw(symbol, &lib);
}
source

pub unsafe fn try_as_raw_ptr(self) -> Option<*mut c_void>

Try to convert the symbol into a raw pointer. Success depends on the platform. Currently, this fn always succeeds and returns some.

§Safety

Using this function relinquishes all the lifetime guarantees. It is up to the developer to ensure the resulting Symbol is not used past the lifetime of the Library this symbol was loaded from.

source§

impl<'lib, T> Symbol<'lib, Option<T>>

source

pub fn lift_option(self) -> Option<Symbol<'lib, T>>

Lift Option out of the symbol.

§Examples
unsafe {
    let lib = Library::new("/path/to/awesome.module").unwrap();
    let symbol: Symbol<Option<*mut u32>> = lib.get(b"symbol\0").unwrap();
    let symbol: Symbol<*mut u32> = symbol.lift_option().expect("static is not null");
}

Trait Implementations§

source§

impl<'lib, T> Clone for Symbol<'lib, T>

source§

fn clone(&self) -> Symbol<'lib, T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for Symbol<'_, T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Deref for Symbol<'_, T>

source§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

impl<T: Send> Send for Symbol<'_, T>

source§

impl<T: Sync> Sync for Symbol<'_, T>

Auto Trait Implementations§

§

impl<'lib, T> Freeze for Symbol<'lib, T>

§

impl<'lib, T> RefUnwindSafe for Symbol<'lib, T>
where T: RefUnwindSafe,

§

impl<'lib, T> Unpin for Symbol<'lib, T>
where T: Unpin,

§

impl<'lib, T> UnwindSafe for Symbol<'lib, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.