Struct ocl::async::OrderLock

pub struct OrderLock<V> { /* fields omitted */ }

A lock with conserved global order 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 OrderGuard.

Platform Compatibility

Some CPU device/platform combinations have synchronization problems when accessing an OrderLock 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.

Methods

impl<V> OrderLock<V>

pub fn new(data: V) -> OrderLock<V>

Creates and returns a new OrderLock.

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

Returns a new FutureGuard which will resolve into a a OrderGuard.

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

Returns a new FutureGuard which will resolve into a a OrderGuard.

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<V: Debug> Debug for OrderLock<V>

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

Formats the value using the given formatter.

impl<V> From<QrwLock<V>> for OrderLock<V>

fn from(q: QrwLock<V>) -> OrderLock<V>

Performs the conversion.

impl<V> From<V> for OrderLock<V>

fn from(vec: V) -> OrderLock<V>

Performs the conversion.

impl<V> Clone for OrderLock<V>

fn clone(&self) -> OrderLock<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: OclPrm> From<OrderLock<Inner<T>>> for BufferSink<T>

fn from(order_lock: OrderLock<Inner<T>>) -> BufferSink<T>

Performs the conversion.

impl<T: OclPrm> From<OrderLock<Inner<T>>> for BufferStream<T>

fn from(order_lock: OrderLock<Inner<T>>) -> BufferStream<T>

Performs the conversion.