Enum VfError 

#[non_exhaustive]
pub enum VfError {
    Op {
        index: usize,
        err_no: u32,
        domain: ErrorDomain,
        operation: Option<&'static str>,
        path: Option<PathBuf>,
    },
    Transport {
        index: Option<usize>,
        message: String,
        operation: Option<&'static str>,
        path: Option<PathBuf>,
    },
}

The failure of one operation in a vectorized call.

Either a filesystem status failure attributable to a specific operation index, or a transport / client-side failure (where the index is optional because some failures cannot be attributed to one request). An indexed failure does not roll back an already-completed prefix, and a transport failure can make the outcome of an in-flight mutation ambiguous.

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.

Op

A filesystem status failure; err_no is errno-style or an NFS4ERR code, mirroring the C tc_res struct.

Fields

index: usize

err_no: u32

domain: ErrorDomain

operation: Option<&'static str>

path: Option<PathBuf>

Transport

A transport / client-side failure with a human-readable message; there is no filesystem status (err_no reports VF_ERR_RPC). index is None when the failure cannot be attributed to any operation.

Fields

index: Option<usize>

message: String

operation: Option<&'static str>

path: Option<PathBuf>

Implementations

impl VfError

pub fn failure(index: usize, err_no: u32) -> VfError

pub fn client(index: usize, code: u32) -> VfError

pub fn nfs(index: usize, status: u32) -> VfError

A status returned by an NFS server.

pub fn smb(index: usize, status: u32) -> VfError

A status returned by an SMB server.

pub fn transport( index: impl Into<Option<usize>>, message: impl Into<String>, ) -> VfError

A transport / client-side failure. index is best-effort; pass None when the failure cannot be attributed to a specific operation.

pub fn unsupported(index: usize) -> VfError

pub fn index(&self) -> usize

👎Deprecated:

use index_opt(); an unknown transport location is not request zero

The operation index this error refers to (best-effort for transport failures; 0 when unknown).

pub fn index_opt(&self) -> Option<usize>

The operation index as an Option; None only for a transport failure that cannot be attributed to any operation.

pub fn err_no(&self) -> u32

The filesystem status code, or VF_ERR_RPC for transport failures.

pub fn is_transport(&self) -> bool

Whether this is a transport / client-side failure (no filesystem status).

pub fn from_rpc(e: RpcError, index: impl Into<Option<usize>>) -> VfError

Convert a low-level RpcError into a VfError, attributing the failure to index in the caller’s operation array. index is the caller’s operation index, which may differ from the compound-internal op index; for transport failures the index is best-effort. The transport message (if any) is preserved.

pub fn from_rpc_indexed(e: RpcError) -> VfError

Like from_rpc, but trusts e.op_index as the caller-relative operation index for a server status. Transport errors keep an unknown index because RpcError uses zero only as a wire/API placeholder in that case.

pub fn with_index(self, index: usize) -> VfError

Re-attribute this error to a different operation index.

pub fn map_index(self, map: impl FnOnce(usize) -> usize) -> VfError

Transform a known request index while preserving an unattributable transport failure as None.

pub fn with_context( self, operation: &'static str, path: impl Into<PathBuf>, ) -> VfError

Attach operation and path context without string parsing.

pub fn domain(&self) -> ErrorDomain

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

pub fn operation(&self) -> Option<&'static str>

pub fn path(&self) -> Option<&Path>

impl VfError

pub fn failed_item_certainty(&self) -> OutcomeCertainty

Completion certainty for the failed item in a vector operation.

This deliberately says nothing about earlier items in the same vector: VFSI is ordered but non-transactional, so a successful prefix may already have changed filesystem state.

pub fn failed_item_retry_class(&self) -> RetryClass

Retry guidance for the failed item, not for the entire vector call. Retrying a whole mutation vector can repeat its completed prefix.

pub fn certainty(&self) -> OutcomeCertainty

👎Deprecated since 0.2.0:

this describes only the failed item; use failed_item_certainty

Deprecated ambiguous spelling; use Self::failed_item_certainty.

pub fn retry_class(&self) -> RetryClass

👎Deprecated since 0.2.0:

this describes only the failed item; use failed_item_retry_class

Deprecated ambiguous spelling; use Self::failed_item_retry_class.

Trait Implementations

impl Clone for VfError

fn clone(&self) -> VfError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VfError

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

Formats the value using the given formatter.

impl Display for VfError

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

Formats the value using the given formatter.

impl Eq for VfError

impl Error for VfError

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 PartialEq for VfError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for VfError