Struct ClassifiedError 

pub struct ClassifiedError {
    pub category: ErrorCategory,
    pub message: String,
    pub suggestion: String,
}

A classified error with category, message, and actionable suggestion.

This struct wraps an error message with its classification and provides helpful suggestions for resolving the issue.

Fields

category: ErrorCategory

The error category

message: String

The original error message

suggestion: String

An actionable suggestion for resolving the error

Implementations

impl ClassifiedError

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

Creates a new classified error from an error message.

Arguments

• message - The error message to classify

Examples

use camgrab_core::error::ClassifiedError;

let error = ClassifiedError::new("401 Unauthorized");
assert_eq!(error.category, camgrab_core::error::ErrorCategory::Auth);
assert!(error.suggestion.contains("username and password"));

pub fn with_category( category: ErrorCategory, message: impl Into<String>, ) -> Self

Creates a new classified error with an explicit category.

Arguments

• category - The error category
• message - The error message

Examples

use camgrab_core::error::{ClassifiedError, ErrorCategory};

let error = ClassifiedError::with_category(
    ErrorCategory::NetworkTimeout,
    "Connection timed out after 30s"
);
assert_eq!(error.category, ErrorCategory::NetworkTimeout);

pub fn with_custom_suggestion( category: ErrorCategory, message: impl Into<String>, suggestion: impl Into<String>, ) -> Self

Creates a new classified error with a custom suggestion.

Arguments

• category - The error category
• message - The error message
• suggestion - A custom suggestion

Trait Implementations

impl Clone for ClassifiedError

fn clone(&self) -> ClassifiedError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClassifiedError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClassifiedError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ClassifiedError

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

Formats the value using the given formatter.

impl Error for ClassifiedError

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 ClassifiedError

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ClassifiedError

impl StructuralPartialEq for ClassifiedError