Skip to main content

Crate mesh_channel

Crate mesh_channel 

Source
Expand description

Higher-level channel types and utilities built on top of mesh_channel_core.

This crate provides the ergonomic channel abstractions that most mesh users interact with:

  • channel() / oneshot() — re-exported from mesh_channel_core for basic message passing.
  • rpc — Rpc<I, R> and FailableRpc<I, R> for request/response patterns where the caller awaits a reply.
  • cell — Cell<T> / CellUpdater<T> for reactive push-based configuration updates.
  • cancel — CancelContext for cooperative cancellation with optional deadlines, transferable across processes.
  • pipe — ReadPipe / WritePipe implementing AsyncRead / AsyncWrite over mesh with backpressure.
  • error — RemoteError and RemoteResult for error propagation across process boundaries.

Most code should use the mesh facade crate rather than depending on this crate directly.

Modules§

cancel
Cancel context support.
cell
An implementation of a cell type that can be updated from a remote mesh node.
error
Remotable errors.
pipe
Implementation a unidirectional byte stream pipe over mesh.
rpc
Remote Procedure Call functionality.

Structs§

ChannelError
An error representing a failure of a channel.
MpscReceiver
The receiving half of a channel returned by channel.
MpscSender
The sending half of a channel returned by channel.
OneshotReceiver
The receiving half of a channel returned by oneshot.
OneshotSender
The sending half of a channel returned by oneshot.
Receiver
The receiving half of a channel returned by channel.
Sender
The sending half of a channel returned by channel.

Enums§

ChannelErrorKind
The kind of channel failure.
RecvError
An error when receiving a message from a channel.
TryRecvError
An error when trying to receive a message from a channel.

Functions§

channel
Creates a new channel for sending messages of type T, returning the sender and receiver ends.
mpsc_channel
Creates a new channel for sending messages of type T, returning the sender and receiver ends.
oneshot
Creates a unidirection channel for sending a single value of type T.