Struct ocl::async::FutureMemMap

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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 = Error

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. Read more

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

Block the current thread until this future is resolved. Read more

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

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

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

Map this future’s error to a different error, returning a new future. Read more

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

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

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

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

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

Execute another future after this one has resolved successfully. Read more

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

Execute another future if this one resolves with an error. Read more

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

Waits for either one of two futures to complete. Read more

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

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

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

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

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

Same as join, but with more futures.

fn join4<B, C, D>( self, b: B, c: C, d: D ) -> Join4<Self, ::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>, Self: Sized,

Same as join, but with more futures.

fn join5<B, C, D, E>( self, b: B, c: C, d: D, e: E ) -> Join5<Self, ::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>, Self: Sized,

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>
where Self: Sized,

Convert this future into a single element stream. Read more

fn fuse(self) -> Fuse<Self>
where Self: Sized,

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

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

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

fn shared(self) -> Shared<Self>
where Self: Sized,

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

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

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

Auto Trait Implementations§

impl<T> UnwindSafe for FutureMemMap<T>
where T: RefUnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<F> IntoFuture for F
where F: Future,

type Future = F

The future that this type can be converted into.

type Item = <F as Future>::Item

The item that the future may resolve with.

type Error = <F as Future>::Error

The error that the future may resolve with.

fn into_future(self) -> F

Consumes this object and produces a future.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.