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

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

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.

## Methods

### `impl<T> RwVec<T>`
[src]

#### `pub fn new() -> RwVec<T>`
[src]

Creates and returns a new `RwVec`.

#### `pub fn read(self) -> FutureGuard<Vec<T>, ReadGuard<Vec<T>>>`
[src]

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

#### `pub fn write(self) -> FutureGuard<Vec<T>, WriteGuard<Vec<T>>>`
[src]

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

####
ⓘImportant traits for &'a [ u8 ]

### Important traits for &'a [ u8 ]

`impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]`
`pub unsafe fn as_mut_slice(&self) -> &mut [T]`
[src]

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

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

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

Returns a reference to the inner value.

#### `pub fn as_mut_ptr(&self) -> *mut V`
[src]

Returns a mutable reference to the inner value.

## Trait Implementations

### `impl<T: Clone> Clone for RwVec<T>`
[src]

#### `fn clone(&self) -> RwVec<T>`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from `source`. Read more

### `impl<T: Debug> Debug for RwVec<T>`
[src]

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

Formats the value using the given formatter. Read more

### `impl<T> From<QrwLock<Vec<T>>> for RwVec<T>`
[src]

#### `fn from(q: QrwLock<Vec<T>>) -> RwVec<T>`
[src]

Performs the conversion.

### `impl<T> From<Vec<T>> for RwVec<T>`
[src]

#### `fn from(vec: Vec<T>) -> RwVec<T>`
[src]

Performs the conversion.

### `impl<T> Deref for RwVec<T>`
[src]

#### `type Target = OrderLock<Vec<T>>`

The resulting type after dereferencing.

#### `fn deref(&self) -> &OrderLock<Vec<T>>`
[src]

Dereferences the value.

### `impl<T> DerefMut for RwVec<T>`
[src]

#### `fn deref_mut(&mut self) -> &mut OrderLock<Vec<T>>`
[src]

Mutably dereferences the value.

# 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`)