filament-interfaces · serial

Read the current implementation boundaries before integration. This reference reproduces declarations; it omits source comments whose examples or readiness claims have not been verified.

Source: sigil/weave/filament/filament-interfaces/src/serial.rs. SHA-256: a19a5210d45bc66bac1eb195696828a23ba0243c800eb18d404edf4ca8ffd1b1.

This reference follows declared source modules, retains conditional attributes, and includes public declarations and implementation methods. Private-module re-exports and trait resolution require the compiler; this is a source reference, not a claim that every listed item is a root import. Function bodies and constant values are omitted.

Module condition:

#[cfg(feature = "serial")]

serial::SerialConfig

#[cfg(feature = "serial")]
#[derive(Debug, Clone)]
pub struct SerialConfig {
/// Serial port path (e.g., "/dev/ttyUSB0", "COM3")

pub port: String,
/// Baud rate

pub baud_rate: u32,
/// Data bits

pub data_bits: DataBits,
/// Parity

pub parity: Parity,
/// Stop bits

pub stop_bits: StopBits,
/// Flow control

pub flow_control: FlowControl,
/// Read timeout

pub timeout: Duration,
/// Interface mode

pub mode: InterfaceMode,
/// Optional IFAC authentication

pub ifac: Option<IFAC>
}

Source line: 18.

serial::SerialConfig::new

#[cfg(feature = "serial")]
pub fn new(port: impl Into<String>, baud_rate: u32) -> Self;

Source line: 57.

serial::SerialInterface

#[cfg(feature = "serial")]
pub struct SerialInterface {

}

Source line: 101.

serial::SerialInterface::new

#[cfg(feature = "serial")]
pub async fn new(
        port: impl Into<String>,
        baud_rate: u32,
        mode: InterfaceMode,
    ) -> Result<Self, InterfaceError>;

Source line: 108.

serial::SerialInterface::from_config

#[cfg(feature = "serial")]
pub async fn from_config(config: SerialConfig) -> Result<Self, InterfaceError>;

Source line: 123.