Struct Config

#[non_exhaustive]
pub struct Config {
    pub baudrate: Baud,
    pub parity: Parity,
    pub stopbits: StopBits,
}

Configuration struct for Serial providing all communication-related / parameters. Serial always uses eight data bits plus the parity bit - if selected.

Create a configuration by using default in combination with the builder methods. The following snippet shows creating a configuration for 19,200 Baud, 8N1 by deriving it from the default value:

let config = Config::default().baudrate(19_200.Bd());

assert!(config.baudrate == 19_200.Bd());
assert!(config.parity == Parity::None);
assert!(config.stopbits == StopBits::STOP1);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

baudrate: Baud

Serial interface baud rate

parity: Parity

Whether and how to generate/check a parity bit

stopbits: StopBits

The number of stop bits to follow the last data bit or the parity bit

Implementations

impl Config

pub fn baudrate(self, baudrate: impl Into<Baud>) -> Self

Sets the given baudrate.

pub fn parity(self, parity: Parity) -> Self

Sets the given parity.

pub fn stopbits(self, stopbits: StopBits) -> Self

Sets the stop bits to stopbits.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Creates a new configuration with typically used parameters: 115,200 Baud 8N1.

impl<T: Into<Baud>> From<T> for Config

fn from(b: T) -> Config

Converts to this type from the input type.

impl PartialEq for Config

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Config

impl Eq for Config

impl StructuralPartialEq for Config