Struct ocl::async::RwVec

pub struct RwVec<T> { /* private fields */ }

A locking Vec which interoperates with OpenCL events and Rust futures to provide exclusive access to data.

Calling ::read or ::write returns a future which will resolve into a RwGuard.

Platform Compatibility

Some CPU device/platform combinations have synchronization problems when accessing an RwVec from multiple threads. Known platforms with problems are 2nd and 4th gen Intel Core processors (Sandy Bridge and Haswell) with Intel OpenCL CPU drivers. Others may be likewise affected. Run the device_check.rs example to determine if your device/platform is affected. AMD platform drivers are known to work properly on the aforementioned CPUs so use those instead if possible.

Implementations

impl<T> RwVec<T>

pub fn new() -> RwVec<T>

Creates and returns a new RwVec.

pub fn read(self) -> FutureGuard<Vec<T>, ReadGuard<Vec<T>>>

Returns a new FutureRwGuard which will resolve into a a RwGuard.

pub fn write(self) -> FutureGuard<Vec<T>, WriteGuard<Vec<T>>>

Returns a new FutureRwGuard which will resolve into a a RwGuard.

pub unsafe fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice into the contained Vec.

Used by buffer command builders when preparing future read and write commands.

Do not use unless you are 100% certain that there will be no other reads or writes for the entire access duration (only possible if manually manipulating the lock status).

pub fn len_stale(&self) -> usize

Returns the length of the internal Vec.

Concurrency Considerations

The returned length is to be considered immediately stale (out of date) due to the fact that other threads may be modifying it. To obtain an accurate state of the internal Vec, the containing RwVec must first be locked with ::read or ::write.

pub fn id(&self) -> usize

Returns a pointer address to the internal array, usable as a unique identifier.

Note that resizing the Vec will likely change the address. Also, the same ‘id’ could be reused by another RwVec created after this one is dropped.

Methods from Deref<Target = OrderLock<Vec<T>>>

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

Returns a reference to the inner value.

pub fn as_mut_ptr(&self) -> *mut V

Returns a mutable reference to the inner value.

Trait Implementations

impl<T: Clone> Clone for RwVec<T>

fn clone(&self) -> RwVec<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for RwVec<T>

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

Formats the value using the given formatter.

impl<T> Deref for RwVec<T>

type Target = OrderLock<Vec<T>>

The resulting type after dereferencing.

fn deref(&self) -> &OrderLock<Vec<T>>

Dereferences the value.

impl<T> DerefMut for RwVec<T>

fn deref_mut(&mut self) -> &mut OrderLock<Vec<T>>

Mutably dereferences the value.

impl<'a, 'd, T> From<&'a RwVec<T>> for WriteSrc<'d, T>

where T: OclPrm,

fn from(rw_vec: &'a RwVec<T>) -> WriteSrc<'d, T>

Converts to this type from the input type.

impl<T> From<QrwLock<Vec<T>>> for RwVec<T>

fn from(q: QrwLock<Vec<T>>) -> RwVec<T>

Converts to this type from the input type.

impl<'d, T> From<RwVec<T>> for WriteSrc<'d, T>

where T: OclPrm,

fn from(rw_vec: RwVec<T>) -> WriteSrc<'d, T>

Converts to this type from the input type.

impl<T> From<Vec<T>> for RwVec<T>

fn from(vec: Vec<T>) -> RwVec<T>

Converts to this type from the input type.