Struct SerialTransport 

pub struct SerialTransport { /* private fields */ }

Frame-oriented Transport over a USB-derived serial endpoint.

Implementations

impl SerialTransport

pub fn new(system_name: impl Into<String>, device: impl Into<PathBuf>) -> Self

Open device on a system_name-tagged transport with the default baud rate (115200) and 4 MiB max frame size.

pub fn with_options( system_name: impl Into<String>, device: impl Into<PathBuf>, baud: u32, max_frame_size: usize, reconnect_policy: ReconnectPolicy, ) -> Self

Construct with explicit baud, max frame size, and reconnect policy. Baud is ignored for true USB CDC-ACM endpoints (the rate is set by the link, not the user) but retained for true UARTs over USB-to-serial dongles.

pub fn local_address(&self) -> Option<Address>

The local Address returned by listen(). None until then.

pub fn with_streams<R, W>( system_name: impl Into<String>, reader: R, writer: W, max_frame_size: usize, ) -> Self

where R: AsyncRead + Unpin + Send + 'static, W: AsyncWrite + Unpin + Send + 'static,

Drive the transport over caller-supplied byte-stream halves instead of opening a serial device. Useful for testing (with tokio::io::duplex) and for layering the Akka protocol over custom byte pipes (Unix sockets, SSH-tunneled streams, raw fds from external tools). No reconnect is attempted; if the streams close, the transport stays closed until shutdown.

Trait Implementations

impl Transport for SerialTransport

fn listen<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Address, TransportError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Bind a listener and return the local Address.

fn associate<'life0, 'life1, 'async_trait>( &'life0 self, _target: &'life1 Address, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Open (or reuse) an outbound association to target.

fn send<'life0, 'life1, 'async_trait>( &'life0 self, _target: &'life1 Address, pdu: AkkaPdu, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Send a single PDU to the peer at target. Implementations are expected to associate lazily if needed.

fn inbound(&self) -> UnboundedReceiver<InboundFrame>

Take ownership of the inbound stream. Calling more than once returns an empty channel.

fn disassociate<'life0, 'life1, 'async_trait>( &'life0 self, _target: &'life1 Address, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Drop a specific association (used by quarantine).

fn shutdown<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stop listening and close all associations.