Struct ark_api::core::DebugContextProperty

pub struct DebugContextProperty { /* private fields */ }

Debug context property

This can be used to give a module additional context for debugging panics and crashes by describing key module state by instantiating properties that describe different types of state. For example which level is loaded in a module.

If there are any panics or crashes in the module during the lifetime of this object then this context will be included in those panic / crash reports.

Note that this is intended for debugging purposes also and should only be select important state, not describe tons of state in the module. So recommendation is to use max 10 properties or so and update them when they change, not many times per frame / module call.

Example

In this example we load a level, and there can only be a single level active at the time so we can put the debug context property directly inside the object so it the debug context property is active while the level is active.

struct Level {
    name: String,
    _debug_prop: DebugContextProperty
}

impl Level {
    pub fn new(name: String) -> Self {
        let _debug_prop = DebugContextProperty::new("level", &name)
        Self {
            name,
            _debug_prop
        }
    }
}

Implementations

impl DebugContextProperty

pub fn new(name: &'static str, value: impl Display) -> Self

Creates a new debug context property

The name of the property is global and unique to the module, supposed to be brief and is required to be static. The value of the property can be any string but generally single-line strings are preferred.

Name and value strings may be capped by the host.

pub fn push(&mut self, value: impl Display)

Push a new value for an existing debug context property in the same stack.

pub fn pop(&mut self)

Pop a value of an existing debug context property stack.

Does nothing if the property stack was already empty.

pub fn reset(&mut self, value: impl Display)

Replace the current value of an existing debug context property (equivalent to pop and push).

Trait Implementations

impl Debug for DebugContextProperty

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

Formats the value using the given formatter.

impl Drop for DebugContextProperty

fn drop(&mut self)

Executes the destructor for this type.