Enum Error 

pub enum Error {
    InvalidData {
        message: String,
    },
    Protocol {
        status: NtStatus,
        command: Command,
    },
    Auth {
        message: String,
    },
    Io(Error),
    Timeout,
    Disconnected,
    DfsReferralRequired {
        path: String,
    },
    Cancelled,
    SessionExpired,
    FileTooLargeForSingleRead {
        size: u64,
        max_read: u32,
    },
}

Top-level error type for SMB2 operations.

Variants

InvalidData

The data is malformed or does not match the expected format.

Fields

message: String

Description of what went wrong.

Protocol

The server returned a non-success NTSTATUS.

Fields

status: NtStatus

The NTSTATUS code from the response header.

command: Command

The command that triggered the error.

Auth

Authentication failed.

Fields

message: String

Description of what went wrong.

Io(Error)

An I/O or transport error occurred.

Timeout

The operation timed out.

Disconnected

The connection was lost.

DfsReferralRequired

The path requires DFS referral resolution.

The server returned STATUS_PATH_NOT_COVERED, meaning this path lives on a different server via DFS. The caller can query for a referral or display a helpful message.

Fields

path: String

The path that needs DFS resolution.

Cancelled

The operation was cancelled by the caller (via progress callback).

SessionExpired

The session expired and reauthentication failed.

The pipeline normally handles STATUS_NETWORK_SESSION_EXPIRED transparently by reauthenticating. This error surfaces only when reauthentication itself fails.

FileTooLargeForSingleRead

The file is larger than a single READ can return, so a one-shot read would truncate it.

Returned by Tree::read_file and Tree::read_file_compound when the file’s size exceeds the server’s negotiated per-READ maximum (MaxReadSize). Those paths issue a single READ, so a larger file can’t come back whole — rather than silently dropping the tail, they fail with this. Switch to Tree::read_file_pipelined, which reads the whole file in a sliding window of chunked READs regardless of size. Classifies as ErrorKind::TooLarge.

Fields

size: u64

The file’s size in bytes.

max_read: u32

The server’s negotiated maximum bytes per READ (MaxReadSize).

Implementations

impl Error

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

Create an InvalidData error with the given message.

pub fn is_retryable(&self) -> bool

Returns true if this error is potentially transient and the operation could succeed on retry.

pub fn status(&self) -> Option<NtStatus>

Returns the NTSTATUS code if this is a protocol error.

impl Error

pub fn kind(&self) -> ErrorKind

Classify this error into a high-level category.

Consumers can match on ErrorKind without understanding raw NTSTATUS codes. For the underlying status code, use status().

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.