Enum ModbusError 

#[non_exhaustive]
pub enum ModbusError {
    NoError,
    Timeout(String),
    Connection(String),
    Protocol(String),
    Exception {
        function: u8,
        code: u8,
    },
    Serial(String),
    Other(String),
}

Structured Modbus / transport error — no string parsing needed.

Use Display for short UI messages and detail for full diagnostic logs.

Short label for UI

Use label for a short human-readable tag suitable for display in a status bar or error column.

Example

use oms_modbus::ModbusError;

// Match on specific error kinds
let result: Result<Vec<u16>, ModbusError> = Err(ModbusError::timeout("RTU recv timed out"));

match &result {
    Err(ModbusError::Timeout(_)) => println!("Retry or re-connect"),
    Err(ModbusError::Exception { function: _, code: _ }) => println!("Modbus exception"),
    Err(e) => eprintln!("{} — {}", e.label(), e.detail()),
    Ok(_) => {}
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NoError

No error — normal/expected response.

Timeout(String)

Connection(String)

Protocol(String)

Exception

Fields

function: u8

code: u8

Serial(String)

Other(String)

Implementations

impl ModbusError

pub fn detail(&self) -> String

Full diagnostic message using centralized message prefixes. Use this for log output; Display gives a short summary for UI.

pub fn label(&self) -> &'static str

Short label for UI display (status bar, error column).

pub const fn no_error() -> Self

Create a successful (no-error) result. label() returns "OK".

pub fn timeout(msg: impl Into<String>) -> Self

Create a timeout error. Covers send and recv timeouts.

pub fn connection(msg: impl Into<String>) -> Self

Create a connection error. Covers TCP connect/read/write failures.

pub fn protocol(msg: impl Into<String>) -> Self

Create a protocol error. Covers CRC mismatch, slave ID mismatch, invalid PDU.

pub fn exception(function: u8, code: u8) -> Self

Create a Modbus exception error from a server response.

pub fn serial(msg: impl Into<String>) -> Self

Create a serial port error. Covers port open/read/write failures.

pub fn other(msg: impl Into<String>) -> Self

Create a miscellaneous error. Used for uncategorized failures.

Trait Implementations

impl Clone for ModbusError

fn clone(&self) -> ModbusError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModbusError

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

Formats the value using the given formatter.

impl Display for ModbusError

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

Short summary for UI display. Delegates to label for simple variants; adds context for Exception and Other.

impl Error for ModbusError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for ModbusError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<ExceptionResponse> for ModbusError

fn from(er: ExceptionResponse) -> Self

Converts to this type from the input type.

impl From<Response> for ModbusError

fn from(rsp: Response) -> Self

Convert a Response to a ModbusError.

• Response::Exception → ModbusError::Exception
• Everything else → ModbusError::Protocol (unexpected success response in an error context — prefer unexpected_response for direct handling in ModbusClient default methods)

impl From<String> for ModbusError

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq for ModbusError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ModbusError