Skip to main content

CrashReporter

Struct CrashReporter 

Source
pub struct CrashReporter(/* private fields */);
Expand description

Cheap cloneable handle to the installed crash reporter.

Implementations§

Source§

impl CrashReporter

Source

pub fn install(options: CrashReporterOptions) -> Result<Self>

Install the process-wide panic hook and, unless disabled, the native fatal-signal handler.

Installing twice is an error; use CrashReporter::current to reach the existing handle.

Source

pub fn detached(options: CrashReporterOptions) -> Result<Self>

Build a reporter that owns its directory but installs no process-wide hooks.

Deterministic tests and secondary tools use this to exercise writing, retention, parsing, and upload without changing global process state.

Source

pub fn current() -> Option<Self>

The installed reporter, when CrashReporter::install has already succeeded.

Source

pub fn directory(&self) -> &Path

Directory holding retained reports.

Source

pub fn max_reports(&self) -> usize

Configured retention count.

Source

pub fn max_report_bytes(&self) -> usize

Configured per-report byte limit.

Source

pub fn add_extra_parameter( &self, key: impl Into<String>, value: impl Into<String>, ) -> Result<()>

Add or replace one bounded extra parameter recorded in later reports.

Source

pub fn remove_extra_parameter(&self, key: &str) -> bool

Remove one extra parameter, reporting whether it was present.

Source

pub fn extra_parameters(&self) -> BTreeMap<String, String>

A snapshot of the retained extra parameters.

Source

pub fn capture_report(&self, report: &CrashReport) -> Result<PathBuf>

Write one caller-built report atomically and apply retention.

Source

pub fn last_crash_report(&self) -> Result<Option<CrashReport>>

The newest retained report, parsed from disk.

Source

pub fn pending_reports(&self) -> Result<Vec<CrashReport>>

Every retained report in oldest-to-newest order, bounded by the configured retention.

Source

pub fn delete_report(&self, id: &str) -> Result<bool>

Delete one retained report by identifier, reporting whether it existed.

Source

pub fn upload_endpoint(&self) -> Option<&str>

The endpoint configured through CrashReporterOptions::upload_endpoint.

Source

pub fn upload_body(report: &CrashReport) -> Result<Vec<u8>>

Build the exact JSON body one upload sends for a report.

Source

pub fn upload_pending(&self, endpoint: &str) -> Result<UploadSummary>

POST every retained report to endpoint, deleting the ones the endpoint accepts.

At most MAX_CRASH_UPLOAD_REPORTS reports are sent per call. Reports the endpoint rejects stay on disk for the next attempt.

Source

pub fn build_report( &self, kind: CrashKind, message: impl Into<String>, ) -> CrashReport

Build a report for the current process using the reporter’s identity and parameters.

Trait Implementations§

Source§

impl Clone for CrashReporter

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CrashReporter

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more