Crate hyperlane_broadcast

hyperlane-broadcast is a lightweight and ergonomic wrapper over Tokio’s broadcast channel designed for easy-to-use publish-subscribe messaging in async Rust applications. It simplifies the native Tokio broadcast API by providing a straightforward interface for broadcasting messages to multiple subscribers with minimal boilerplate.

Structs

Broadcast

Re-exports constants, structs, traits, and types from the broadcast module. Represents a broadcast mechanism for sending messages to multiple receivers.

BroadcastMap

Re-exports structs, traits, and types from the broadcast_map module. Represents a concurrent, thread-safe map of broadcast channels, keyed by string.

Constants

DEFAULT_BROADCAST_SENDER_CAPACITY

Re-exports constants, structs, traits, and types from the broadcast module. Defines the default capacity for a broadcast sender.

Traits

BroadcastMapTrait

Re-exports structs, traits, and types from the broadcast_map module. Defines the essential traits required for types that can be used as values in a BroadcastMap.

BroadcastTrait

Re-exports constants, structs, traits, and types from the broadcast module. Defines the essential traits required for types that can be broadcast.

Type Aliases

BroadcastMapReceiver

Re-exports structs, traits, and types from the broadcast_map module. Represents a receiver endpoint for a broadcast channel within a map, allowing consumption of broadcasted messages.

BroadcastMapSendError

Re-exports structs, traits, and types from the broadcast_map module. Represents an error that occurs when attempting to send a message via a broadcast channel within a map.

BroadcastMapSendResult

Re-exports structs, traits, and types from the broadcast_map module. Represents the result of a broadcast map send operation, indicating either success with an optional receiver count or an error.

BroadcastMapSender

Re-exports structs, traits, and types from the broadcast_map module. Represents a sender endpoint for a broadcast channel within a map, used to dispatch messages.

BroadcastReceiver

Re-exports constants, structs, traits, and types from the broadcast module. Represents a receiver endpoint for a broadcast channel, allowing consumption of broadcasted messages.

BroadcastSendError

Re-exports constants, structs, traits, and types from the broadcast module. Represents an error that occurs when attempting to send a message via broadcast.

BroadcastSendResult

Re-exports constants, structs, traits, and types from the broadcast module. Represents the result of a broadcast send operation, indicating either success with the number of receivers or an error.

BroadcastSender

Re-exports constants, structs, traits, and types from the broadcast module. Represents a sender endpoint for a broadcast channel, used to dispatch messages to all subscribed receivers.

Capacity

Re-exports constants, structs, traits, and types from the broadcast module. Represents the maximum capacity or buffer size of a broadcast channel.

DashMapStringBroadcast

Re-exports structs, traits, and types from the broadcast_map module. A concurrent, thread-safe map where keys are strings and values are broadcast channels.

OptionBroadcast

Re-exports structs, traits, and types from the broadcast_map module. Represents an optional broadcast channel.

OptionBroadcastMapReceiver

Re-exports structs, traits, and types from the broadcast_map module. Represents an optional receiver endpoint for a broadcast channel within a map.

OptionBroadcastMapSender

Re-exports structs, traits, and types from the broadcast_map module. Represents an optional sender endpoint for a broadcast channel within a map.

OptionReceiverCount

Re-exports structs, traits, and types from the broadcast_map module. Represents an optional count of active receivers.

ReceiverCount

Re-exports constants, structs, traits, and types from the broadcast module. Represents the number of active receivers subscribed to a broadcast channel.