Struct tarantool::fiber::JoinHandle

pub struct JoinHandle<'f, T> { /* private fields */ }

An owned permission to join a fiber (block on its termination).

NOTE: if JoinHandle is dropped before JoinHandle::join is called on it a panic will happen. Moreover some of the memory needed for passing the result from the fiber to the caller will be leaked in case the panic is caught. Note also that panics within tarantool are in general not recoverable.

Implementations

impl<'f, T> JoinHandle<'f, T>

pub fn join(self) -> T

Block until the fiber’s termination and return it’s result value.

pub fn id(&self) -> FiberId

Returns the underlying fiber id.

The fiber id can be used for example with wakeup, cancel, exists, csw_of, etc.

Panicking

This will panic if the current tarantool executable doesn’t support the required api (i.e. has_fiber_id returns false). Consider using Self::id_checked if you want to handle this error.

pub fn id_checked(&self) -> Option<FiberId>

Returns the underlying fiber id or None if the current tarantool executable doesn’t support the required api (i.e. has_fiber_id returns false).

The fiber id can be used for example with wakeup, cancel, exists, csw_of, etc.

pub fn cancel(&self)

Cancel the underlying fiber.

Does NOT yield.

NOTE: tarantool does not guarantee that the cancelled fiber stops executing. It’s the responsibility of the fiber’s author to check if it was cancelled by checking is_cancelled or similar after any yielding calls and explicitly returning.

pub fn wakeup(&self)

Wakeup the underlying fiber.

Does NOT yield.

Trait Implementations

impl<'f, T> Debug for JoinHandle<'f, T>

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

Formats the value using the given formatter.

impl<'f, T> Drop for JoinHandle<'f, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'f, T: Hash> Hash for JoinHandle<'f, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'f, T: PartialEq> PartialEq for JoinHandle<'f, T>

fn eq(&self, other: &JoinHandle<'f, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'f, T: Eq> Eq for JoinHandle<'f, T>

impl<'f, T> StructuralEq for JoinHandle<'f, T>

impl<'f, T> StructuralPartialEq for JoinHandle<'f, T>