Enum Error 

#[non_exhaustive]
pub enum Error {
    Io {
        path: PathBuf,
        source: Error,
    },
    BencodeSyntax {
        offset: usize,
        message: String,
    },
    BencodeCanonical {
        offset: usize,
        message: String,
    },
    Metainfo {
        field: String,
        message: String,
    },
    ResourceLimit {
        limit: &'static str,
        actual: usize,
        maximum: usize,
    },
    Unsupported {
        message: String,
    },
    Verification {
        path: Option<PathBuf>,
        message: String,
    },
    Cancelled,
}

Errors returned by the BTPC core library.

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.

Io

An I/O operation failed for a path.

Fields

path: PathBuf

Path associated with the failed operation.

source: Error

Underlying I/O error.

BencodeSyntax

Bencode syntax is invalid.

Fields

offset: usize

Byte offset where the violation was detected.

message: String

Human-readable explanation.

BencodeCanonical

Bencode is parseable but not canonical.

Fields

offset: usize

Byte offset where the violation was detected.

message: String

Human-readable explanation.

Metainfo

A metainfo field is invalid.

Fields

field: String

Dot-separated bencode field path.

message: String

Human-readable explanation.

ResourceLimit

A parser or allocation resource limit was exceeded.

Fields

limit: &'static str

Stable name of the configured limit.

actual: usize

Observed or requested amount.

maximum: usize

Configured maximum amount.

Unsupported

A requested feature or policy is unsupported.

Fields

message: String

Human-readable explanation.

Verification

Payload verification found a mismatch.

Fields

path: Option<PathBuf>

Optional payload path associated with the mismatch.

message: String

Human-readable explanation.

Cancelled

The operation was cancelled.

Implementations

impl Error

pub fn io(path: impl Into<PathBuf>, source: Error) -> Self

Creates an I/O error with path context.

pub fn bencode_syntax(offset: usize, message: impl Into<String>) -> Self

Creates a bencode syntax error.

pub fn bencode_canonical(offset: usize, message: impl Into<String>) -> Self

Creates a canonical bencode error.

pub fn metainfo_field( field: impl Into<String>, message: impl Into<String>, ) -> Self

Creates a metainfo field error.

pub fn unsupported(message: impl Into<String>) -> Self

Creates an unsupported-feature error.

pub fn verification_mismatch( path: Option<PathBuf>, message: impl Into<String>, ) -> Self

Creates a payload verification mismatch.

pub const fn cancelled() -> Self

Creates a cancellation error.

pub const fn category(&self) -> ErrorCategory

Returns the stable category for this error.

pub const fn offset(&self) -> Option<usize>

Returns the associated byte offset, when present.

pub fn field(&self) -> Option<&str>

Returns the associated metainfo field path, when present.

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

Returns the associated filesystem path, when present.

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

Returns the stable resource-limit name, when present.

pub const fn actual_and_maximum(&self) -> Option<(usize, usize)>

Returns the observed and maximum resource amounts, when present.

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 StdError + '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.