LcBarContext

Struct LcBarContext 

Source
pub struct LcBarContext<'a, T> {
    pub lc: &'a LeechCore,
    pub ctxlock: RwLock<T>,
    /* private fields */
}
Expand description

PCIe BAR Context: Supplied by LeechCore to the BAR callback function.

Contains the lc field which gives access to the general API.

Contains the ctxlock field which gives access to the user-defined generic struct set at plugin initialization.

The ctxlock field is a std::sync::RwLock and the inner user-defined generic struct may be accessed in either multi-threaded read-mode or single-threaded mutable write-mode. Read mode is more efficient.

See the plugin example for additional use cases and documentation.

Only one BAR callback may be active at a given time for a given native LeechCore instance. Previous instances will become inactive if a new one is started. To inactivate a callback drop the context.

§Created By

  • LeechCore::pcie_bar_callback()

Fields§

§lc: &'a LeechCore

Access the general LeechCore API through the lc field.

§ctxlock: RwLock<T>

Access generic user-set plugin context in a thread-safe way.

Trait Implementations§

Source§

impl<T> Display for LcBarContext<'_, T>

Source§

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

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

impl<T> Drop for LcBarContext<'_, T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a, T> !Freeze for LcBarContext<'a, T>

§

impl<'a, T> RefUnwindSafe for LcBarContext<'a, T>

§

impl<'a, T> Send for LcBarContext<'a, T>
where T: Send,

§

impl<'a, T> Sync for LcBarContext<'a, T>
where T: Send + Sync,

§

impl<'a, T> Unpin for LcBarContext<'a, T>
where T: Unpin,

§

impl<'a, T> UnwindSafe for LcBarContext<'a, 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.