Struct FaultMessage 

pub struct FaultMessage { /* private fields */ }

The message a FaultKind::Panic or FaultKind::AssertFailed carries.

A fault kind alone cannot say what the program stopped for, and panic’s whole contract is an explicit message (§9.1). The wrapper renders the value the program passed — through its descriptor, exactly as out would — and leaves the text here; the host reads it when it renders the fault.

Rendering happens in the wrapper rather than at report time on purpose: the argument is a GcRef into a heap that the host tears down, so keeping the reference would make the message outlive what it points at. A String does not.

Host-managed, like crate::ParseDetail: generated code never reads or writes it.

Implementations

impl FaultMessage

pub fn new() -> FaultMessage

An empty slot.

pub fn set(&mut self, text: String)

Record text as the message for the fault being raised.

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

The recorded message, or None when the pending fault carries none.

pub fn clear(&mut self)

Forget any recorded message.

Trait Implementations

impl Debug for FaultMessage

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

Formats the value using the given formatter.

impl Default for FaultMessage

fn default() -> FaultMessage

Returns the “default value” for a type.