Enum Baudrate

#[repr(u16)]
pub enum Baudrate {
    BR1200 = 0,
    BR2400 = 1,
    BR4800 = 2,
    BR9600 = 3,
    BR19200 = 4,
    BR38400 = 5,
    BR57600 = 6,
    BR115200 = 7,
}

Represents supported baudrates for Modbus communication.

Each variant maps to an internal ID used within the protocol. The actual baudrate values (e.g., 9600, 115200) can be obtained via conversion.

---

Supports

• u32 -> Baudrate
• u64 -> Baudrate
• Baudrate -> u32
• Baudrate -> u64

Variants

BR1200 = 0

BR2400 = 1

BR4800 = 2

BR9600 = 3

BR19200 = 4

BR38400 = 5

BR57600 = 6

BR115200 = 7

Implementations

impl Baudrate

pub fn from_id(id: u16) -> Option<Baudrate>

Attempts to create a Baudrate from its internal ID.

This is used when a baudrate needs to be reconstructed from a stored or transmitted ID.

---

Args

• id: The internal identifier corresponding to a Baudrate.

---

Returns

Some(..) if the ID matches a known baudrate, otherwise None.

---

Examples

use modbus_rtu::common::Baudrate;

assert_eq!(Baudrate::from_id(3), Some(Baudrate::BR9600));
assert_eq!(Baudrate::from_id(99), None);

pub fn to_id(&self) -> u16

Converts the Baudrate variant into its internal ID representation.

This ID can be stored or transmitted and later converted back using Baudrate::from_id.

---

Returns

The internal u16 ID associated with the baudrate.

---

Examples

use modbus_rtu::common::Baudrate;

assert_eq!(Baudrate::BR9600.to_id(), 3);

pub fn packet_end_us(&self) -> u64

Calculates the packet end timeout in microseconds based on the baudrate.

In Modbus RTU communication, this value defines the idle time required to consider a packet as ended. (3.5 char time)

---

Returns

The idle time (in microseconds) required to delimit the end of a Modbus RTU packet at this baudrate.

---

Examples

use modbus_rtu::common::Baudrate;

let baud = Baudrate::BR9600;
let packet_end_us: u64 = baud.packet_end_us();

Trait Implementations

impl Clone for Baudrate

fn clone(&self) -> Baudrate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Baudrate

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

Formats the value using the given formatter.

impl From<&Baudrate> for u32

fn from(value: &Baudrate) -> Self

Converts to this type from the input type.

impl From<&Baudrate> for u64

fn from(value: &Baudrate) -> Self

Converts to this type from the input type.

impl From<Baudrate> for u32

fn from(value: Baudrate) -> Self

Converts to this type from the input type.

impl From<Baudrate> for u64

fn from(value: Baudrate) -> Self

Converts to this type from the input type.

impl Ord for Baudrate

fn cmp(&self, other: &Baudrate) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Baudrate

fn eq(&self, other: &Baudrate) -> 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 PartialOrd for Baudrate

fn partial_cmp(&self, other: &Baudrate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<u32> for Baudrate

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Baudrate

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Baudrate

impl Eq for Baudrate

impl StructuralPartialEq for Baudrate