Enum Error 

#[non_exhaustive]
pub enum Error {
    CompatibilityViolation(&'static str),
    InvalidBuilderConfiguration(&'static str),
    #[non_exhaustive]
    SinkWriteFailed {
        sink_index: usize,
        source: Error,
    },
    Io(Error),
}

Errors returned by the rusty_pee library API.

Per FR-028 + FR-029, the enum carries the enum-level #[non_exhaustive] marker (protects future variant additions) AND each non-unit variant individually carries #[non_exhaustive] (protects future field additions inside variants).

Examples

use rusty_pee::Error;

let e = Error::CompatibilityViolation("--capture not honored in Strict mode");
assert_eq!(e.to_string(), "compatibility violation: --capture not honored in Strict mode");

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.

CompatibilityViolation(&'static str)

A Default-mode-only setting was passed to Strict mode (or vice versa). Returned from PeeBuilder::build() only — before any IO occurs, so no sinks are touched.

InvalidBuilderConfiguration(&'static str)

The builder was configured into an impossible state (e.g., explicit settings whose combination is logically invalid). Returned from PeeBuilder::build() only.

#[non_exhaustive]

SinkWriteFailed

A sink’s write failed mid-stream. Surfaced only when the builder was configured with ignore_write_errors(false). Carries the registration index of the failing sink and the underlying io error.

Observable state: surviving sinks have received the complete current chunk in registration order (per FR-036). The failing sink is dropped from the live-set.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

sink_index: usize

source: Error

Io(Error)

An underlying IO error from the reader or process layer.

Observable state: may leave sinks in a partially-written state for the current chunk.

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.