Module prelude

Module prelude 

Source
Expand description

Curated re-exports for the most common umbrella-crate entry points.

This prelude intentionally favors the application-facing path: Host -> LocalNode -> PeerConnection -> payload wrapper.

Lower-level MAC coordinator types remain available from [crate::mac], but are not pulled into the prelude by default.

Structs§

BoundChannel
A channel bound to a specific LocalNode. Implements Transport.
Channel
A channel descriptor — holds the key, derived ID, and display name.
ChannelId
Two-byte multicast channel identifier.
ChannelInfoRef
Borrowing view of an inbound MAC event.
ChannelKey
Raw 32-byte multicast channel secret.
Host
Multi-identity orchestration layer for the node API.
LocalIdentityId
Opaque handle that identifies a locally registered identity within the [Mac] coordinator.
LocalNode
Per-identity application handle.
MessageSequence
Message Sequence option value.
MulticastTextChatWrapper
NodeCapabilities
NodeIdentityPayload
OwnedTextMessage
Owned counterpart of TextMessage.
PeerConnection
Relationship with one remote peer, bound to a transport context.
PublicKey
Node public key, which also acts as the full network address.
ReceivedPacketRef
Borrowed view of one accepted inbound packet together with parsed on-wire metadata.
RouteHops
Iterator over packed two-byte route hops from a source-route or trace-route option.
RxMetadata
Local physical-layer observations captured when a frame was received.
SendOptions
High-level transmission options passed to Mac send helpers.
SendProgressTicket
Lightweight handle for observing the progress of an in-flight send.
SendToken
Identity-scoped send token.
Snr
Signal-to-noise ratio represented in centibels (0.1 dB units).
Subscription
Owned subscription guard.
TextMessage
Borrowed decoded text message.
UnicastTextChatWrapper
Thin convenience wrapper for plain unicast text chat over a peer connection.

Enums§

CommandId
HostError
Error returned when a Host cannot make progress.
MacCommand
MessageType
Text-message rendering/control type.
NodeError
Errors produced by node-layer operations.
NodeRole
OwnedMacCommand
PacketFamily
Coarser grouping of on-wire packet types.
PayloadType
Application payload type carried inside the MAC body.
PfsStatus
Regarding
Regarding option value: a reference to a previously sent message.

Traits§

Platform
Bundle of platform-specific associated types used by the higher layers.
Transport
A context through which UMSH frames can be sent.