Struct Error

pub struct Error {
    pub description: String,
    pub detail: String,
    pub fingerprint: Fingerprint,
    pub type_name: String,
    pub tags: BTreeMap<String, String>,
    pub user: User,
    pub uuid: Uuid,
}

A sentry error.

Errors are automatically reported when dropped.

Fields

description: String

A short description of the error.

detail: String

A detailed description of the error.

fingerprint: Fingerprint

The fingerprint of the error.

Errors with the same fingerprint are grouped together. The default groups by [type] and ClientOptions::environment.

type_name: String

The type of the error.

tags: BTreeMap<String, String>

Additional tags to apply to the error.

user: User

User data to send with the error.

uuid: Uuid

The UUID of the event.

Implementations

impl Error

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

Creates a new error with the given type.

pub fn set_description(&mut self, description: impl ToString)

Sets the short description of the error.

pub fn set_detail(&mut self, detail: impl ToString)

Sets the detailed description of the error.

pub fn set_tag(&mut self, name: impl Into<String>, value: impl ToString)

Adds extra tagged information.

pub fn with_description(self, description: impl ToString) -> Self

Sets the short description of the error.

pub fn with_detail(self, detail: impl ToString) -> Self

Sets the detailed description of the error.

pub fn with_fingerprint(self, fingerprint: Fingerprint) -> Self

Sets the fingerprint used to group the error.

pub fn with_tag(self, name: impl Into<String>, value: impl ToString) -> Self

Adds extra tagged information.

pub fn with_user(self, user: User) -> Self

Adds user information.

pub fn with_user_id(self, id: impl ToString) -> Self

Adds user ID information.

pub fn report(self) -> Uuid

Reports this error to sentry.

Equivalent to dropping the error, but returns the error Uuid.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Drop for Error

fn drop(&mut self)

Executes the destructor for this type.