Struct saberrs::SabertoothPortShared

pub struct SabertoothPortShared { /* fields omitted */ }

Clonable variant of SabertoothPort.

It is more flexible, for example it allows to mix several protocols (PlainText and PacketSerial) with the same port. However in most cases SabertoothPort is enough and recommended.

The downside of SabertoothPortShared, besides possible performance loss, is that it is not Send.

Example

use std::time::Duration;
use saberrs::{Result, SabertoothSerial, SabertoothPortShared};
use saberrs::sabertooth2x32::{PacketSerial, PacketType, PlainText, Sabertooth2x32};


let mut dev = SabertoothPortShared::new("/dev/ttyS2")?;

// The following interfaces will all communicate using the same port, but
// using different protocols.
let mut sabertext = PlainText::from(&dev);
let mut saberchecksum = PacketSerial::from(&dev).with_packet_type(PacketType::Checksum);
let mut sabercrc = PacketSerial::from(&dev).with_packet_type(PacketType::CRC);

Requires the "serialport" feature (enabled by default).

Implementations

impl SabertoothPortShared

pub fn new(port: &str) -> Result<SabertoothPortShared>

Create a new SabertoothPortShared with a default configuration

Trait Implementations

impl Clone for SabertoothPortShared

fn clone(&self) -> SabertoothPortShared

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SabertoothPortShared

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

Formats the value using the given formatter.

impl Read for SabertoothPortShared

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl SabertoothSerial for SabertoothPortShared

fn set_timeout(&mut self, timeout: Duration) -> Result<()>

Set the timeout of the serial port.

fn timeout(&self) -> Duration

Get the current timeout setting of the serial port.

fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()>

Set the baud rate of the serial port.

fn baud_rate(&self) -> Result<u32>

Get the current baud rate setting of the serial port.

fn clear_all(&self) -> Result<()>

Clear the tx and rx buffer, remaining bytes will be lost.

impl Write for SabertoothPortShared

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writeer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.