Struct traceback_error::TracebackError

pub struct TracebackError {
    pub message: String,
    pub file: String,
    pub line: u32,
    pub parent: Option<Box<TracebackError>>,
    pub time_created: DateTime<Utc>,
    pub extra_data: Value,
    pub project: Option<String>,
    pub computer: Option<String>,
    pub user: Option<String>,
    pub is_parent: bool,
    pub is_handled: bool,
    /* private fields */
}

A custom error struct for handling tracebacks in Rust applications.

This struct is designed to capture error information such as the error message, the file and line where the error occurred, and additional contextual data.

Examples

Creating a new TracebackError with a custom message:

use chrono::{DateTime, Utc};
use serde_json::Value;
use traceback_error::TracebackError;

let error = traceback!("Custom error message");
println!("{:?}", error);

Fields

• message: A string containing the error message.
• file: A string containing the filename where the error occurred.
• line: An unsigned integer representing the line number where the error occurred.
• parent: An optional boxed TracebackError representing the parent error, if any.
• time_created: A chrono::DateTime<Utc> indicating when the error was created.
• extra_data: A serde_json::Value for storing additional error-related data.
• project: An optional string representing the project name.
• computer: An optional string representing the computer name.
• user: An optional string representing the username.
• is_parent: A boolean indicating if this error is considered a parent error.
• is_handled: A boolean indicating if the error has been handled.
• is_default: A boolean indicating if this error is the default error.

Default Implementation

The Default trait is implemented for TracebackError, creating a default instance with the following values:

• message: “Default message”
• file: The current file’s name (using file!()).
• line: The current line number (using line!()).
• parent: None
• time_created: The Unix epoch time.
• extra_data: Value::Null
• project: None
• computer: None
• user: None
• is_parent: false
• is_handled: false
• is_default: true

Equality Comparison

The PartialEq trait is implemented for TracebackError, allowing you to compare two TracebackError instances for equality based on their message, file, line, and other relevant fields. The is_handled and is_default fields are not considered when comparing for equality.

Dropping Errors

Errors are automatically dropped when they go out of scope, but before they are dropped, they are handled by the TRACEBACK_ERROR_CALLBACK function. By default, this function simply serializes the error and writes it to a JSON file.

Callback Types

The callback function can be either synchronous or asynchronous, depending on the TracebackCallbackType set globally using the TRACEBACK_ERROR_CALLBACK variable. It can be set using the set_callback! macro.

• If TRACEBACK_ERROR_CALLBACK is Some(TracebackCallbackType::Async), an asynchronous callback function is used.
• If TRACEBACK_ERROR_CALLBACK is Some(TracebackCallbackType::Sync), a synchronous callback function is used.
• If TRACEBACK_ERROR_CALLBACK is None, a default callback function is used.

Creating Errors

You can create a new TracebackError instance using the traceback! macro. Additional data can be added using the with_extra_data method, and environment variables are automatically added when the error is being handled.

Environment Variables

The with_env_vars method populates the project, computer, and user fields with information obtained from environment variables (CARGO_PKG_NAME, COMPUTERNAME, and USERNAME, respectively) or assigns default values if the environment variables are not present.

Fields

message: String

file: String

line: u32

parent: Option<Box<TracebackError>>

time_created: DateTime<Utc>

extra_data: Value

project: Option<String>

computer: Option<String>

user: Option<String>

is_parent: bool

is_handled: bool

Implementations

impl TracebackError

pub fn new(message: String, file: String, line: u32) -> Self

pub fn with_extra_data(self, extra_data: Value) -> Self

Trait Implementations

impl Clone for TracebackError

fn clone(&self) -> TracebackError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TracebackError

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

Formats the value using the given formatter.

impl Default for TracebackError

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TracebackError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TracebackError

This display implementation is recursive, and will print the error and all its parents with a tab in front of each parent.

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

Formats the value using the given formatter.

impl Drop for TracebackError

fn drop(&mut self)

Executes the destructor for this type.

impl Error for TracebackError

fn custom<T: Display>(msg: T) -> Self

Raised when there is general error when deserializing a type.

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl Error for TracebackError

fn source(&self) -> Option<&(dyn Error + 'static)>

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<TracebackError> for TracebackError

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for TracebackError

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

Serialize this value into the given Serde serializer.