Struct ocl::FutureMemMap

#[must_use = "futures do nothing unless polled"]
pub struct FutureMemMap<T: OclPrm> { /* fields omitted */ }

A future which resolves to a MemMap as soon as its creating command completes.

[UNSTABLE]: This type's methods may be renamed or otherwise changed at any time.

Methods

impl<T: OclPrm> FutureMemMap<T>

pub unsafe fn new(
    core: MemMapCore<T>,
    len: usize,
    map_event: Event,
    buffer: Mem,
    queue: Queue
) -> FutureMemMap<T>

Returns a new FutureMemMap.

pub fn set_unmap_wait_events<El>(&mut self, wait_events: El) where
    El: Into<EventList>, 

Set an event wait list for the unmap command.

Setting a wait list here will disallow any wait list from being set later if/when calling unmap manually.

[UNSTABLE]: This method may be renamed or otherwise changed.

pub fn ewait_unmap<L: Into<EventList>>(self, wait_events: L) -> FutureMemMap<T>

Set an event wait list for the unmap command.

See ::set_unmap_wait_events.

pub fn create_unmap_event(&mut self) -> OclResult<&mut Event>

Create an event which will be triggered (set complete) after this future resolves into a MemMap and after that MemMap is dropped or manually unmapped.

The returned event can be added to the wait list of subsequent OpenCL commands with the expectation that when all preceeding futures are complete, the event will automatically be 'triggered' by having its status set to complete, causing those commands to execute. This can be used to inject host side code in amongst OpenCL commands without thread blocking or extra delays of any kind.

[UNSTABLE]: This method may be renamed or otherwise changed.

pub fn enew_unmap<En>(self, enew: En) -> FutureMemMap<T> where
    En: ClNullEventPtr, 

Specifies an event which will be triggered (set complete) after this future resolves into a MemMap and after that MemMap is dropped or manually unmapped.

See ::create_unmap_event.

pub fn set_unmap_queue(&mut self, queue: Queue)

Specifies the queue to be used for the unmap command.

pub fn with_unmap_queue(self, queue: Queue) -> FutureMemMap<T>

Specifies the queue to be used for the unmap command.

pub fn unmap_event(&self) -> Option<&Event>

Returns the unmap event if it has been created.

[UNSTABLE]: This method may be renamed or otherwise changed.

pub fn wait(self) -> OclResult<MemMap<T>>

Blocks the current thread until the OpenCL command is complete and an appropriate lock can be obtained on the underlying data.

Trait Implementations

impl<T: Debug + OclPrm> Debug for FutureMemMap<T>

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

Formats the value using the given formatter.

impl<T> Future for FutureMemMap<T> where
    T: OclPrm + 'static, 

type Item = MemMap<T>

The type of value that this future will resolved with if it is successful.

type Error = OclError

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<Self::Item, Self::Error>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U, 

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 

Map this future's error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    B: IntoFuture,
    F: FnOnce(Result<Self::Item, Self::Error>) -> B, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    B: IntoFuture<Error = Self::Error>,
    F: FnOnce(Self::Item) -> B, 

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    B: IntoFuture<Item = Self::Item>,
    F: FnOnce(Self::Error) -> B, 

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>, 

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where
    B: IntoFuture, 

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>, 

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(
    self,
    b: B,
    c: C
) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>, 

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error == Self::Error, 

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item), 

Do something with the item of a future, passing it on.

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.

impl<T: OclPrm> Send for FutureMemMap<T>

impl<T: OclPrm> Sync for FutureMemMap<T>