Skip to main content

SendPtr

Struct SendPtr 

Source
pub struct SendPtr<T>(/* private fields */);
Expand description

A raw pointer wrapper that is Send + Sync.

Used to capture *const Params / host-handle pointers in PluginContext closures without the ptr as usize hack. The Send/Sync impls are unconditional in T - they have to be, because the wrapped types are typically #[repr(C)] host structs that are themselves !Send + !Sync by default. Construction is therefore unsafe: each call site must justify why cross-thread access to the pointed-to data is sound.

Justifications used in-tree:

  • P: Params - fields are atomic; concurrent reads from the GUI thread while the audio thread writes are safe by design.
  • Format-host handles (clap_host, AEffect, etc.) - used only from a single thread (UI), and the wrapping is purely for capturing in Send + Sync closures stored in PluginContext.

The pointed-to data must outlive the SendPtr. In the plugin context, the plugin instance (which owns the params) always outlives the editor.

Implementations§

Source§

impl<T> SendPtr<T>

Source

pub unsafe fn new(ptr: *const T) -> Self

Wrap a raw pointer.

§Safety

The caller must ensure that:

  1. The pointed-to data outlives every clone of this SendPtr.
  2. Cross-thread access to *ptr is sound - either because T is Sync, because access is synchronized externally (atomic fields, Mutex, single-thread-only access pattern), or because the wrapper is only ever read on a thread where T: Sync would hold.
Source

pub unsafe fn get(&self) -> &T

Dereference the pointer.

§Safety

The pointed-to data must still be alive.

Source

pub fn as_ptr(&self) -> *const T

Get the raw pointer.

Trait Implementations§

Source§

impl<T> Clone for SendPtr<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Copy for SendPtr<T>

Source§

impl<T> Send for SendPtr<T>

Source§

impl<T> Sync for SendPtr<T>

Auto Trait Implementations§

§

impl<T> Freeze for SendPtr<T>

§

impl<T> RefUnwindSafe for SendPtr<T>
where T: RefUnwindSafe,

§

impl<T> Unpin for SendPtr<T>

§

impl<T> UnsafeUnpin for SendPtr<T>

§

impl<T> UnwindSafe for SendPtr<T>
where T: RefUnwindSafe,

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.