# Struct ocl::async::ReadGuard [−] [src]

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

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

## Methods

### `impl<V> ReadGuard<V>`
[src]

#### `pub fn release_event(guard: &ReadGuard<V>) -> Option<&Event>`
[src]

Returns a reference to the event previously set using `create_release_event` on the `FutureGuard` which preceded this `ReadGuard`. 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 `ReadGuard` is dropped.

#### `pub fn release(guard: ReadGuard<V>) -> OrderLock<V>`
[src]

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

## Trait Implementations

### `impl<V: Debug> Debug for ReadGuard<V>`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl<V> Deref for ReadGuard<V>`
[src]

#### `type Target = V`

The resulting type after dereferencing.

####
ⓘImportant traits for &'a mut R

### 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`
[src]

Dereferences the value.

### `impl<V> Drop for ReadGuard<V>`
[src]

#### `fn drop(&mut self)`
[src]

Executes the destructor for this type. Read more

### `impl<V> OrderGuard<V> for ReadGuard<V>`
[src]

#### `fn new(order_lock: OrderLock<V>, release_event: Option<Event>) -> ReadGuard<V>`
[src]

#### `fn order_lock(&self) -> &OrderLock<V>`
[src]

#### `unsafe fn forget(self)`
[src]

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)