mavlink-core 0.21.0

use core::fmt::Display;
use core::time::Duration;

/// MAVLink address for a serial connection
///
/// # Example
///
/// ```ignore
/// use mavlink::{Connectable, SerialConfig};
///
/// let config = SerialConfig::new("/dev/ttyTHS1".to_owned(), 115200);
/// config.connect::<mavlink::ardupilotmega::MavMessage>();
/// ```
#[derive(Debug, Clone)]
pub struct SerialConfig {
    pub(crate) port_name: String,
    pub(crate) baud_rate: u32,
    pub(crate) timeout: Option<Duration>,
    read_buffer_capacity: usize,
}

impl SerialConfig {
    /// Creates a serial connection address with port name and baud rate.
    pub fn new(port_name: String, baud_rate: u32) -> Self {
        // Calculate a sane default buffer capacity based on the baud rate.
        let default_capacity = (baud_rate / 100).clamp(1024, 1024 * 8) as usize;

        Self {
            port_name,
            baud_rate,
            timeout: None,
            read_buffer_capacity: default_capacity,
        }
    }

    /// Sets the serial port timeout.
    ///
    /// When set, serial reads will return an error after the specified duration.
    ///
    /// By default, this is 1 millisecond.
    ///
    /// Only applies to sync connections and is a no-op for async ones.
    pub fn timeout(mut self, timeout: Duration) -> Self {
        self.timeout = Some(timeout);
        self
    }

    /// Updates the read buffer capacity.
    pub fn with_read_buffer_capacity(mut self, capacity: usize) -> Self {
        self.read_buffer_capacity = capacity;
        self
    }

    /// Returns the configured read buffer capacity.
    pub fn buffer_capacity(&self) -> usize {
        self.read_buffer_capacity
    }
}

impl Display for SerialConfig {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "serial:{}:{}", self.port_name, self.baud_rate)
    }
}