Module tarantool::fiber

Сooperative multitasking module with optional async runtime.

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(),
• spawn a fiber based async runtime.

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
  Async runtime based on Tarantool fibers. Also includes sycnhronization primitives and useful traits for working with futures.
• 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).
• Fiber
  OBSOLETE: This struct is being deprecated in favour of Fyber, due to them being more efficient and idiomatic.
• FiberAttr
  Fiber attributes container
• Fyber
  A helper struct which is used to store information about a fiber being created. It’s only utility is the generic parameter which are associated with it.
• 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.
• NoFunc
  This is a typestate helper type representing the state of a Builder that hasn’t been assigned a fiber function yet.

Enums

• YieldResult
  Possible check_yield results.

Functions

• check_yield
  Calls a function and checks whether it yielded.
• clock
  Get Instant corresponding to event loop iteration begin time. 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 JoinHandle for it.
• defer_async
  Async version of defer.
• defer_procDeprecated
  Creates a new fiber and schedules it for execution, returning a JoinHandle<()> 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_procDeprecated
  Creates a new fiber and yields execution to it immediately, returning a [JoinHandle<()>] for the new fiber.
• yield
  Returns control to the scheduler. Works likewise fiber::sleep(Duration::ZERO) but return error if fiber was canceled by another routine.

Type Aliases

• LuaJoinHandleDeprecated
• LuaUnitJoinHandleDeprecated
• UnitJoinHandleDeprecated