Struct OpenSerialOptions 

pub struct OpenSerialOptions { /* private fields */ }

Available on crate feature binary only.

Options for configuring and opening a serial port.

Example

let mut port = OpenSerialOptions::new()
    .timeout(Some(Duration::from_millis(50)))
    .open("/dev/ttyUSB0")?;

Implementations

impl OpenSerialOptions

pub const DEFAULT_BAUD_RATE: u32 = 9_600

The default baud rate for the Binary protocol: 9,600.

pub fn new() -> Self

Create a blank set of options ready for configuration.

The default baud rate and read timeout are 9,600 and 5 seconds, respectively.

Equivalent to default.

pub fn baud_rate(&mut self, baud_rate: u32) -> &mut Self

Set a custom baud rate.

pub fn timeout(&mut self, duration: Option<Duration>) -> &mut Self

Set a custom read timeout.

If duration is None, reads will block indefinitely.

pub fn open<'a>(&self, path: &str) -> Result<Port<'a, Serial>, BinaryError>

Open the port at the specified path with the custom options.

pub fn open_dyn<'a>( &self, path: &str, ) -> Result<Port<'a, Box<dyn Backend + Send>>, BinaryError>

Open the port at the specified path with the custom options.

The type of the underlying backend is erased via dynamic dispatch, which does have runtime overhead. open should generally be used instead, except when the type of the underlying backend may not be known at compile time.

Trait Implementations

impl Debug for OpenSerialOptions

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

Formats the value using the given formatter.

impl Default for OpenSerialOptions

fn default() -> Self

Returns the “default value” for a type.