Struct Settings 

pub struct Settings {
    pub baud: u32,
    pub parity: Parity,
    pub stop_bits: StopBits,
}

A port’s speed and character format: eight data bits, with the parity and stop bits given.

Examples

use pamoja_hal::port::{Parity, Settings};

// A Modbus RTU meter at 9600 baud, with the even parity the protocol defaults to: one
// stop bit, and eleven bits a character.
let meter = Settings::new(9_600).with_parity(Parity::Even);
assert_eq!(meter.to_string(), "9600 8E1");
assert_eq!(meter.bits_per_character(), 11);
assert_eq!(meter.character_nanos(), 1_145_834);

Fields

baud: u32

The speed, in bits a second.

parity: Parity

The parity bit each character carries.

stop_bits: StopBits

How many stop bits end each character.

Implementations

impl Settings

pub const fn new(baud: u32) -> Settings

Eight data bits, no parity, and one stop bit, the format most devices start in.

Arguments

• baud - the speed, in bits a second.

Returns

The settings.

pub const fn with_parity(self, parity: Parity) -> Settings

Sets the parity bit.

Arguments

• parity - the parity each character carries.

Returns

The settings.

pub const fn with_stop_bits(self, stop_bits: StopBits) -> Settings

Sets the stop bits.

Arguments

• stop_bits - how many stop bits end each character.

Returns

The settings.

pub const fn bits_per_character(&self) -> u32

Returns the bits one character takes on the wire: a start bit, eight data bits, the parity bit if there is one, and the stop bits.

pub const fn character_nanos(&self) -> u64

Returns how long one character takes on the wire, in nanoseconds, rounded up.

pub const fn transfer_micros(&self, bytes: usize) -> u64

Returns how long a run of bytes takes on the wire, sent back to back, in microseconds, rounded up.

Arguments

• bytes - how many bytes.

Returns

The time on the wire.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Settings

impl Debug for Settings

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

Formats the value using the given formatter.

impl Display for Settings

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

Formats the value using the given formatter.

impl Eq for Settings

impl Hash for Settings

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 PartialEq for Settings

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Settings