Struct glommio::task::JoinHandle[−][src]

pub struct JoinHandle<R> { /* fields omitted */ }

Expand description

A handle that awaits the result of a task.

This type is a future that resolves to an Option<R> where:

None indicates the task has panicked or was canceled.
Some(result) indicates the task has completed with result of type R.

Implementations

[src]

impl<R> JoinHandle<R>

[src]

pub fn cancel(&self)

Cancels the task.

If the task has already completed, calling this method will have no effect.

When a task is canceled, its future will not be polled again.

Trait Implementations

[src]

impl<R> Debug for JoinHandle<R>

[src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

[src]

impl<R> Drop for JoinHandle<R>

[src]

fn drop(&mut self)

Executes the destructor for this type. Read more

[src]

impl<R> Future for JoinHandle<R>

type Output = Option<R>

The type of value produced on completion.

[src]

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

[src]

impl<R> Unpin for JoinHandle<R>

Auto Trait Implementations

impl<R> RefUnwindSafe for JoinHandle<R> where
R: RefUnwindSafe,

impl<R> !Send for JoinHandle<R>

impl<R> !Sync for JoinHandle<R>

impl<R> UnwindSafe for JoinHandle<R> where
R: UnwindSafe,

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<F> FutureExt for F where
F: Future + ?Sized,

[src]

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

A convenience for calling Future::poll() on !Unpin types.

[src]

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more

[src]

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more

[src]

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

Catches panics while polling the future. Read more

[src]

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

Boxes the future and changes its type to dyn Future + Send + 'a. Read more

[src]

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

Boxes the future and changes its type to dyn Future + 'a. Read more

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

[src]

pub fn into_future(self) -> <F as IntoFuture>::Future

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

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

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

[src]

impl<T> WithSubscriber for T

[src]

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct glommio::task::JoinHandle[−][src]

Implementations

impl<R> JoinHandle<R>

pub fn cancel(&self)

Trait Implementations

impl<R> Debug for JoinHandle<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<R> Drop for JoinHandle<R>

fn drop(&mut self)

impl<R> Future for JoinHandle<R>

type Output = Option<R>

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

impl<R> Unpin for JoinHandle<R>

Auto Trait Implementations

impl<R> RefUnwindSafe for JoinHandle<R> where R: RefUnwindSafe,

impl<R> !Send for JoinHandle<R>

impl<R> !Sync for JoinHandle<R>

impl<R> UnwindSafe for JoinHandle<R> where R: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<F> FutureExt for F where F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F> where F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where F: Future<Output = Self::Output>,

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

fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where Self: 'a + Send,

fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where Self: 'a,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Output = <F as Future>::Output

type Future = F

pub fn into_future(self) -> <F as IntoFuture>::Future

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

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

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

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

pub unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<R> RefUnwindSafe for JoinHandle<R> where
R: RefUnwindSafe,

impl<R> UnwindSafe for JoinHandle<R> where
R: UnwindSafe,

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

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

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

impl<F> FutureExt for F where
F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

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

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,