Struct CrashReport 

#[non_exhaustive]
pub struct CrashReport {

    pub version: u32,
    pub when: u64,
    pub message: String,
    pub fatal: bool,
    pub location: Option<String>,
    pub thread: Option<String>,
    pub backtrace: String,
    pub engine: String,
    pub game: String,
    pub target: String,
    pub frame: u32,
    pub top_screen: Option<String>,
    pub log: Vec<String>,
    pub record: Option<String>,
}

What a backend’s panic hook found: plain data, written with to_text and read with parse. Every field but version and message may be missing from a report’s text, so a newer field never stops an older report from reading.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version: u32

The version of its text: REPORT_VERSION.

when: u64

When it happened: milliseconds since 1970 on the backend’s clock.

message: String

The panic’s message, cut at MESSAGE_BYTES.

fatal: bool

Whether the panic ended the game: one on the thread that runs it. A panic on another thread (a sound library’s, with no sound device) is kept, and never offered (offer_last_crash). A report without the field, older than it, reads as true.

location: Option<String>

Where it panicked: file:line:column.

thread: Option<String>

The thread’s name, if it has one.

backtrace: String

The backtrace as the standard library writes it, cut at BACKTRACE_BYTES. A stripped build’s frames are <unknown>.

engine: String

The engine’s version (ENGINE_VERSION).

game: String

The game’s version, empty if the game gave none.

target: String

The OS, the processor and the build: linux x86_64 release.

frame: u32

The frame that was running, counted as App::frame_number counts them.

top_screen: Option<String>

The name of the screen on top, if the game was running.

log: Vec<String>

The last LOG_LINES lines of the log, oldest first, each cut at LOG_LINE_BYTES.

record: Option<String>

The game’s record of its play, in the format its tools’ replay reads (Start::crash_record).

Implementations

impl CrashReport

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

A report of message at when, cut at MESSAGE_BYTES, and nothing else known yet.

pub fn limit(&mut self)

Cuts the message, the backtrace and the log to their limits: the last LOG_LINES lines, each at LOG_LINE_BYTES.

pub fn set_record(&mut self, record: Option<String>)

Sets the game’s record of its play, unless it is over RECORD_BYTES: then the record stays None, and the log’s last line says why.

pub fn to_text(&self) -> String

The report’s text: RON, with \n line endings on every OS.

pub fn parse(text: &str) -> Result<Self, String>

The report text holds, or why it holds none: text over TEXT_BYTES isn’t read. Never panics.

Trait Implementations

impl Clone for CrashReport

fn clone(&self) -> CrashReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CrashReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CrashReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CrashReport

impl PartialEq for CrashReport

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CrashReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CrashReport