Struct ocl::WriteGuard

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

Allows access to the data contained within just like a mutex guard.

Methods

impl<V> WriteGuard<V>

pub fn release_event(guard: &WriteGuard<V>) -> Option<&Event>

Returns a reference to the event previously set using create_release_event on the FutureGuard which preceded this WriteGuard. The event can be manually 'triggered' by calling ...set_complete()... or used normally (as a wait event) by subsequent commands. If the event is not manually completed it will be automatically set complete when this WriteGuard is dropped.

pub fn release(guard: WriteGuard<V>) -> OrderLock<V>

Triggers the release event and releases the lock held by this WriteGuard before returning the original OrderLock.

Trait Implementations

impl<V: Debug> Debug for WriteGuard<V>

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

Formats the value using the given formatter.

impl<V> Deref for WriteGuard<V>

type Target = V

The resulting type after dereferencing.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref(&self) -> &V

Dereferences the value.

impl<V> DerefMut for WriteGuard<V>

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref_mut(&mut self) -> &mut V

Mutably dereferences the value.

impl<V> Drop for WriteGuard<V>

fn drop(&mut self)

Executes the destructor for this type.

impl<V> OrderGuard<V> for WriteGuard<V>

fn new(order_lock: OrderLock<V>, release_event: Option<Event>) -> WriteGuard<V>

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

unsafe fn forget(self)