Struct flipdot_serial::SerialSignBus

pub struct SerialSignBus<P: SerialPort> { /* private fields */ }

An implementation of SignBus that communicates with one or more signs over serial.

Messages and responses are logged using the log crate for debugging purposes. Consuming binaries typically use the env_logger crate and can be run with the RUST_LOG=debug environment variable to watch the bus messages go by.

Examples

use flipdot_serial::SerialSignBus;

let port = serial::open("/dev/ttyUSB0")?;
let bus = SerialSignBus::try_new(port)?;
// Can now connect a Sign to the bus.

Implementations

impl<P: SerialPort> SerialSignBus<P>

pub fn try_new(port: P) -> Result<Self, Error>

Creates a new SerialSignBus that communicates over the specified serial port.

Errors

Returns the underlying serial_core::Error if the serial port cannot be configured.

Examples

let port = serial::open("COM3")?;
let bus = SerialSignBus::try_new(port)?;

pub fn port(&self) -> &P

Returns a reference to the underlying serial port.

Trait Implementations

impl<P: Debug + SerialPort> Debug for SerialSignBus<P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: Hash + SerialPort> Hash for SerialSignBus<P>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<P: PartialEq + SerialPort> PartialEq for SerialSignBus<P>

fn eq(&self, other: &SerialSignBus<P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P: SerialPort> SignBus for SerialSignBus<P>

fn process_message<'a>( &mut self, message: Message<'_> ) -> Result<Option<Message<'a>>, Box<dyn Error + Send + Sync>>

Handles a bus message by sending it to the serial port and reading a response if necessary.

impl<P: Eq + SerialPort> Eq for SerialSignBus<P>

impl<P: SerialPort> StructuralPartialEq for SerialSignBus<P>