Struct reaper_medium::PluginContext

source · [−]

pub struct PluginContext<'a, UsageScope> { /* private fields */ }

Expand description

This represents the context in which this REAPER plug-in runs.

Implementations

source

impl<'a, UsageScope> PluginContext<'a, UsageScope>

source

pub fn get_func<'b>(&self, name: impl Into<ReaperStringArg<'b>>) -> *mut c_voidwhere
UsageScope: MainThreadOnly,

Returns a generic API function by its name.

The returned *mut c_void function pointer must be cast to a function pointer type via transmute(). Please note that it can be null if the desired function is not registered.

source

pub fn h_instance(&self) -> Option<Hinstance>where
UsageScope: AnyThread,

On Windows, this returns the HINSTANCE passed to DllMain (VST plug-ins) or ReaperPluginEntry (extension plug-ins).

The returned HINSTANCE represents the handle of the module (DLL) containing the plug-in.

On Linux, this returns None.

source

pub fn is_in_main_thread(&self) -> boolwhere
UsageScope: AnyThread,

Returns whether we are currently in the main thread.

source

pub fn type_specific(&self) -> TypeSpecificPluginContext<'_>where
UsageScope: AnyThread,

Returns the type-specific plug-in context.

Trait Implementations

source

impl<'a, UsageScope: Clone> Clone for PluginContext<'a, UsageScope>

source

fn clone(&self) -> PluginContext<'a, UsageScope>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'a, UsageScope: Debug> Debug for PluginContext<'a, UsageScope>

source

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

Formats the value using the given formatter. Read more

source

impl<'a, UsageScope: PartialEq> PartialEq<PluginContext<'a, UsageScope>> for PluginContext<'a, UsageScope>

source

fn eq(&self, other: &PluginContext<'a, UsageScope>) -> bool

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<'a, UsageScope> StructuralPartialEq for PluginContext<'a, UsageScope>

Auto Trait Implementations

impl<'a, UsageScope> RefUnwindSafe for PluginContext<'a, UsageScope>where
UsageScope: RefUnwindSafe,

impl<'a, UsageScope> !Send for PluginContext<'a, UsageScope>

impl<'a, UsageScope> !Sync for PluginContext<'a, UsageScope>

impl<'a, UsageScope> Unpin for PluginContext<'a, UsageScope>where
UsageScope: Unpin,

impl<'a, UsageScope> UnwindSafe for PluginContext<'a, UsageScope>where
UsageScope: UnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for Twhere
T: Any,

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 Twhere
T: Clone,

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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct reaper_medium::PluginContext

Implementations

impl<'a, UsageScope> PluginContext<'a, UsageScope>

pub fn get_func<'b>(&self, name: impl Into<ReaperStringArg<'b>>) -> *mut c_voidwhere UsageScope: MainThreadOnly,

pub fn h_instance(&self) -> Option<Hinstance>where UsageScope: AnyThread,

pub fn is_in_main_thread(&self) -> boolwhere UsageScope: AnyThread,

pub fn type_specific(&self) -> TypeSpecificPluginContext<'_>where UsageScope: AnyThread,

Trait Implementations

impl<'a, UsageScope: Clone> Clone for PluginContext<'a, UsageScope>

fn clone(&self) -> PluginContext<'a, UsageScope>

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

impl<'a, UsageScope: Debug> Debug for PluginContext<'a, UsageScope>

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

impl<'a, UsageScope: PartialEq> PartialEq<PluginContext<'a, UsageScope>> for PluginContext<'a, UsageScope>

fn eq(&self, other: &PluginContext<'a, UsageScope>) -> bool

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

impl<'a, UsageScope: Copy> Copy for PluginContext<'a, UsageScope>

impl<'a, UsageScope: Eq> Eq for PluginContext<'a, UsageScope>

impl<'a, UsageScope> StructuralEq for PluginContext<'a, UsageScope>

impl<'a, UsageScope> StructuralPartialEq for PluginContext<'a, UsageScope>

Auto Trait Implementations

impl<'a, UsageScope> RefUnwindSafe for PluginContext<'a, UsageScope>where UsageScope: RefUnwindSafe,

impl<'a, UsageScope> !Send for PluginContext<'a, UsageScope>

impl<'a, UsageScope> !Sync for PluginContext<'a, UsageScope>

impl<'a, UsageScope> Unpin for PluginContext<'a, UsageScope>where UsageScope: Unpin,

impl<'a, UsageScope> UnwindSafe for PluginContext<'a, UsageScope>where UsageScope: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

pub fn get_func<'b>(&self, name: impl Into<ReaperStringArg<'b>>) -> *mut c_voidwhere
UsageScope: MainThreadOnly,

pub fn h_instance(&self) -> Option<Hinstance>where
UsageScope: AnyThread,

pub fn is_in_main_thread(&self) -> boolwhere
UsageScope: AnyThread,

pub fn type_specific(&self) -> TypeSpecificPluginContext<'_>where
UsageScope: AnyThread,

impl<'a, UsageScope> RefUnwindSafe for PluginContext<'a, UsageScope>where
UsageScope: RefUnwindSafe,

impl<'a, UsageScope> Unpin for PluginContext<'a, UsageScope>where
UsageScope: Unpin,

impl<'a, UsageScope> UnwindSafe for PluginContext<'a, UsageScope>where
UsageScope: UnwindSafe,

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

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

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

impl<T> Downcast for Twhere
T: Any,

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

impl<T> ToOwned for Twhere
T: Clone,

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

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