Skip to main content

SerialConfig

Struct SerialConfig 

Source
pub struct SerialConfig {
    pub baud_rate: u32,
    pub data_bits: DataBits,
    pub stop_bits: StopBits,
    pub parity: Parity,
    pub flow_control: FlowControl,
    pub read_timeout: Duration,
}
Expand description

Full serial-link configuration.

SerialConfig is what the CLI builds from command-line flags (see rtcom-cli Issue #3) and what the session orchestrator hands to a SerialDevice at open time. It is also what SerialDevice::config returns so runtime code can display or serialize the current link parameters.

Fields§

§baud_rate: u32

Baud rate in bits per second.

§data_bits: DataBits

Data bits per frame.

§stop_bits: StopBits

Stop bits per frame.

§parity: Parity

Parity mode.

§flow_control: FlowControl

Flow-control mode.

§read_timeout: Duration

Timeout used by blocking reads (unused on the async path, but kept so config() remains a faithful record of the requested settings).

Implementations§

Source§

impl SerialConfig

Source

pub fn validate(&self) -> Result<()>

Validates that the configuration is internally consistent.

Currently only rejects a zero baud rate; more checks (e.g. disallowing Mark/Space on platforms that don’t implement them) may be added in the future.

§Errors

Returns Error::InvalidConfig if the configuration cannot be used to open a device.

Trait Implementations§

Source§

impl Clone for SerialConfig

Source§

fn clone(&self) -> SerialConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SerialConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SerialConfig

Source§

fn default() -> Self

Returns the tio/picocom-compatible default: 115200 8N1, no flow control.

Source§

impl PartialEq for SerialConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for SerialConfig

Source§

impl Eq for SerialConfig

Source§

impl StructuralPartialEq for SerialConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.