Enum NanonisError 

pub enum NanonisError {
    Io {
        source: Error,
        context: String,
    },
    Timeout(String),
    Protocol(String),
    Server {
        code: i32,
        message: String,
    },
}

Error types for Nanonis communication.

This enum represents the four categories of errors that can occur:

• Io - Network and I/O errors
• Timeout - Connection or operation timeouts
• Protocol - Binary protocol parsing/validation errors
• Server - Errors returned by the Nanonis server

Variants

Io

IO error with context describing what operation failed.

Example

use nanonis_rs::NanonisError;

let io_err = std::io::Error::new(std::io::ErrorKind::ConnectionRefused, "refused");
let err = NanonisError::Io {
    source: io_err,
    context: "connecting to server".to_string(),
};
assert!(err.to_string().contains("connecting to server"));

Fields

source: Error

context: String

Timeout(String)

Connection or operation timeout.

Contains an optional description of what timed out.

Example

use nanonis_rs::NanonisError;

let err = NanonisError::Timeout("waiting for scan to complete".to_string());
assert!(err.to_string().contains("scan"));

Protocol(String)

Protocol error during parsing, validation, or type conversion.

This covers all errors related to the binary protocol:

• Unexpected response formats
• Type mismatches in received data
• Invalid command parameters
• Serialization failures

Example

use nanonis_rs::NanonisError;

let err = NanonisError::Protocol("Expected f32, got i32".to_string());
assert!(err.to_string().contains("Expected f32"));

Server

Error returned by the Nanonis server.

The server returns an error code and message when a command fails.

Example

use nanonis_rs::NanonisError;

let err = NanonisError::Server {
    code: -1,
    message: "Invalid parameter".to_string(),
};
assert!(err.is_server_error());
assert_eq!(err.error_code(), Some(-1));

Fields

code: i32

message: String

Implementations

impl NanonisError

pub fn is_server_error(&self) -> bool

Check if this is a server-side error.

pub fn error_code(&self) -> Option<i32>

Get error code if this is a server error.

pub fn is_timeout(&self) -> bool

Check if this is a timeout error.

pub fn is_io(&self) -> bool

Check if this is an I/O error.

pub fn is_protocol(&self) -> bool

Check if this is a protocol error.

Trait Implementations

impl Debug for NanonisError

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

Formats the value using the given formatter.

impl Display for NanonisError

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

Formats the value using the given formatter.

impl Error for NanonisError

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 NanonisError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NanonisError

fn from(error: Error) -> Self

Converts to this type from the input type.