Struct ErrorKind

pub struct ErrorKind(pub &'static str, pub &'static str, pub u16, pub &'static str);

Represents a categorized error kind with associated metadata.

The ErrorKind struct defines a specific type of error, providing a unique identifier, category, numeric code, and a message ID. This allows for structured and meaningful error classification.

Example

let kind = cdumay_error::ErrorKind("NotFound", "MSG001", 404, "Not Found");

Tuple Fields

0: &'static str

A unique error identifier (name).

1: &'static str

A message ID associated with the error.

2: u16

A numeric error code.

3: &'static str

A human-readable description of the error.

Implementations

impl ErrorKind

pub fn name(&self) -> &'static str

Returns the name of the error.

Example

let error = cdumay_error::ErrorKind("NotFound", "MSG001", 404, "Not Found");
assert_eq!(error.name(), "NotFound");

pub fn message_id(&self) -> &'static str

Returns the message ID of the error.

Example

let error = cdumay_error::ErrorKind("NotFound", "MSG001", 404, "Not Found");
assert_eq!(error.message_id(), "MSG001");

pub fn code(&self) -> u16

Returns the numerical error code.

Example

let error = cdumay_error::ErrorKind("NotFound", "MSG001", 404, "Not Found");
assert_eq!(error.code(), 404);

pub fn description(&self) -> &'static str

Returns the description of the error.

Example

let error = cdumay_error::ErrorKind("NotFound", "MSG001", 404, "Not Found");
assert_eq!(error.description(), "Not Found");

pub fn side(&self) -> &'static str

Determines whether the error originates from the client or the server.

• Errors with codes in the range 0 to 499 are classified as Client errors.
• Errors with codes 500 or higher are classified as Server errors.

Example

let client_error = cdumay_error::ErrorKind("NotFound", "MSG001", 404, "Not Found");
assert_eq!(client_error.side(), "Client");

let server_error = cdumay_error::ErrorKind("InternalServerError", "MSG002", 500, "Internal Server Error");
assert_eq!(server_error.side(), "Server");

Trait Implementations

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl PartialEq for ErrorKind

fn eq(&self, other: &ErrorKind) -> 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 ErrorKind