Enum novatel_oem6_api::BaudRate

[+] Show declaration

pub enum BaudRate {
    Baud110,
    Baud300,
    Baud600,
    Baud1200,
    Baud2400,
    Baud4800,
    Baud9600,
    Baud19200,
    Baud38400,
    Baud57600,
    Baud115200,
    BaudOther(usize),
}

[−] Expand description

Serial port baud rates.

Portability

The BaudRate variants with numeric suffixes, e.g., Baud9600, indicate standard baud rates that are widely-supported on many systems. While non-standard baud rates can be set with BaudOther, their behavior is system-dependent. Some systems may not support arbitrary baud rates. Using the standard baud rates is more likely to result in portable applications.

Variants

Baud110

[−] Expand description

110 baud.

Baud300

[−] Expand description

300 baud.

Baud600

[−] Expand description

600 baud.

Baud1200

[−] Expand description

1200 baud.

Baud2400

[−] Expand description

2400 baud.

Baud4800

[−] Expand description

4800 baud.

Baud9600

[−] Expand description

9600 baud.

Baud19200

[−] Expand description

19,200 baud.

Baud38400

[−] Expand description

38,400 baud.

Baud57600

[−] Expand description

57,600 baud.

Baud115200

[−] Expand description

115,200 baud.

BaudOther(usize)

[−] Expand description

Non-standard baud rates.

BaudOther can be used to set non-standard baud rates by setting its member to be the desired baud rate.

serial_core::BaudOther(4_000_000); // 4,000,000 baud

Non-standard baud rates may not be supported on all systems.

Methods

impl BaudRate

[−]

pub fn from_speed(speed: usize) -> BaudRate

[−]

Creates a BaudRate for a particular speed.

This function can be used to select a BaudRate variant from an integer containing the desired baud rate.

Example

assert_eq!(BaudRate::Baud9600, BaudRate::from_speed(9600));
assert_eq!(BaudRate::Baud115200, BaudRate::from_speed(115200));
assert_eq!(BaudRate::BaudOther(4000000), BaudRate::from_speed(4000000));

pub fn speed(&self) -> usize

[−]

Returns the baud rate as an integer.

Example

assert_eq!(9600, BaudRate::Baud9600.speed());
assert_eq!(115200, BaudRate::Baud115200.speed());
assert_eq!(4000000, BaudRate::BaudOther(4000000).speed());

Trait Implementations

impl Copy for BaudRate

impl Eq for BaudRate

impl PartialEq<BaudRate> for BaudRate

[+]

fn eq(&self, other: &BaudRate) -> bool

[−]

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

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

[−]

This method tests for !=.

impl Clone for BaudRate

[+]

fn clone(&self) -> BaudRate

[−]

Returns a copy of the value.

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

[−]

Performs copy-assignment from source.

impl Debug for BaudRate

[+]

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

[−]

Formats the value using the given formatter.