Module tarantool::fiber

Сooperative multitasking module

With the fiber module, you can:

• create, run and manage fibers,
• use a synchronization mechanism for fibers, similar to “condition variables” and similar to operating-system functions such as pthread_cond_wait() plus pthread_cond_signal().

See also:

• Threads, fibers and yields
• Lua reference: Module fiber
• C API reference: Module fiber

Re-exports

pub use channel::Channel;

pub use channel::RecvError;

pub use channel::RecvTimeout;

pub use channel::SendError;

pub use channel::SendTimeout;

pub use channel::TryRecvError;

pub use channel::TrySendError;

pub use mutex::Mutex;

pub use async::block_on;

Modules

async

channel

mutex

Structs

Builder

Fiber factory which can be used to configure the properties of the new fiber.

Cond

Conditional variable for cooperative multitasking (fibers).

Deferred

Fiber

OBSOLETE: This struct is being deprecated in favour of Immediate, Deferred, etc. due to them being more efficient and idiomatic.

FiberAttr

Fiber attributes container

FiberFunc

This is a helper type used to configure Fyber with the appropriate behavior for the fiber function that returns a value.

FiberProc

This is a helper type used to configure Fyber with the appropriate behavior for the fiber procedure (function which doens’t return a value).

Fyber

A handle to a fiber.

Immediate

JoinHandle

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

Latch

A lock for cooperative multitasking environment

LatchGuard

An RAII implementation of a “scoped lock” of a latch. When this structure is dropped (falls out of scope), the lock will be unlocked.

LuaFiber

LuaFiber

LuaFiberFunc

LuaFiberFunc

LuaFiberProc

LuaFiberProc

LuaJoinHandle

LuaJoinHandle

LuaUnitJoinHandle

LuaUnitJoinHandle

NoFunc

This is a typestate helper type representing the state of a Builder that hasn’t been assigned a fiber function yet.

UnitJoinHandle

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

Enums

YieldResult

Possible check_yield results.

Traits

Callee

Callee Types implementing this trait represent Fyber configurations relating to the kind of the fiber function. Currently only 2 kinds of functions are supported:

Invocation

Invocation Types implementing this trait represent Fyber configurations relating to kinds of fiber invocations. Currently there are 2 kinds of invocations supported:

LuaCallee

LuaCallee

Functions

check_yield

Calls a function and checks whether it yielded.

clock

Report loop begin time as double (cheap). Uses monotonic clock.

clock64

Report loop begin time as 64-bit int. Uses monotonic clock.

csw

Returns the number of context switches of the calling fiber.

defer

Creates a new fiber and schedules it for execution, returning a LuaJoinHandle for it.

defer_async

Async version of defer.

defer_proc

Creates a new proc fiber and schedules it for execution, returning a LuaUnitJoinHandle for it.

fiber_yield

Yield control to the scheduler.

is_cancelled

Check current fiber for cancellation (it must be checked manually).

reschedule

Reschedule fiber to end of event loop cycle.

set_cancellable

Make it possible or not possible to wakeup the current fiber immediately when it’s cancelled.

sleep

Put the current fiber to sleep for at least time seconds.

start

Creates a new fiber and yields execution to it immediately, returning a JoinHandle for the new fiber.

start_async

Async version of start.

start_proc

Creates a new proc fiber and yields execution to it immediately, returning a UnitJoinHandle for the new fiber.

time

Report loop begin time as double (cheap).

time64

Report loop begin time as 64-bit int.

yield

Returns control to the scheduler. Works likewise fiber::sleep(Duration::ZERO) but return error if fiber was canceled by another routine.