Struct Error 

pub struct Error {
    pub code: ErrorCode,
    pub message: String,
    pub context: Option<ErrorContext>,
}

Main error type for copybook operations

Uses thiserror for clean error handling with manual Display implementation to avoid allocations in hot paths.

Examples

use copybook_error::{Error, ErrorCode};

let err = Error::new(ErrorCode::CBKP001_SYNTAX, "unexpected token");
assert_eq!(err.code(), ErrorCode::CBKP001_SYNTAX);
assert_eq!(err.family_prefix(), "CBKP");
assert_eq!(err.to_string(), "CBKP001_SYNTAX: unexpected token");

Fields

code: ErrorCode

Stable error code for programmatic handling

message: String

Human-readable error message

context: Option<ErrorContext>

Optional context information

Implementations

impl Error

pub const fn code(&self) -> ErrorCode

Return the stable error code for this error.

pub const fn family_prefix(&self) -> &'static str

Return the CBK* family prefix associated with this error.

impl Error

pub fn new(code: ErrorCode, message: impl Into<String>) -> Error

Create a new error with the specified code and message

This is the primary constructor for copybook-rs errors. The error code should be chosen from the stable ErrorCode taxonomy to enable programmatic error handling.

Arguments

• code - Stable error code from the copybook-rs taxonomy
• message - Human-readable error description

Example

use copybook_error::{Error, ErrorCode};

// Static message
let error1 = Error::new(
    ErrorCode::CBKD411_ZONED_BAD_SIGN,
    "Invalid sign zone in zoned decimal field"
);

// Dynamic message
let field_name = "AMOUNT";
let error2 = Error::new(
    ErrorCode::CBKD411_ZONED_BAD_SIGN,
    format!("Invalid sign zone in field {}", field_name)
);

pub fn with_context(self, context: ErrorContext) -> Error

Add context information to the error

pub fn with_record(self, record_index: u64) -> Error

Add record context to the error

pub fn with_field(self, field_path: impl Into<String>) -> Error

Add field path context to the error

pub fn with_offset(self, byte_offset: u64) -> Error

Add byte offset context to the error

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error