Struct flipdot::SerialSignBus

pub struct SerialSignBus<P> where
    P: SerialPort,  { /* fields omitted */ }

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> SerialSignBus<P> where
    P: SerialPort, 

pub fn try_new(port: P) -> Result<SerialSignBus<P>, 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 for SerialSignBus<P> where
    P: Debug + SerialPort, 

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

Formats the value using the given formatter.

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

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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

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

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

This method tests for !=.

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

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

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

impl<P> StructuralEq for SerialSignBus<P> where
    P: SerialPort, 

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