Struct DebugSnapshot

pub struct DebugSnapshot {
    pub root: u64,
    pub viewport: DebugRect,
    pub nodes: Vec<DebugNode>,
    pub warnings: Vec<DebugWarning>,
    pub terminal_inspections: Vec<TerminalDebugSnapshot>,
    pub selected: Option<u64>,
    pub hovered: Option<u64>,
    pub frame_index: u64,
}

Serializable snapshot of one retained subtree and its derived diagnostics.

Examples

use ailloli_ui_devtools_core::DebugSnapshot;
fn selected(snapshot: &DebugSnapshot) -> Option<u64> { snapshot.selected }

Fields

root: u64

Requested root element ID, even if the ID was absent from the tree.

viewport: DebugRect

Logical viewport used by outside-viewport warnings.

nodes: Vec<DebugNode>

Pre-order flattened nodes reachable from root.

warnings: Vec<DebugWarning>

All derived warnings in node traversal/category order.

terminal_inspections: Vec<TerminalDebugSnapshot>

Optional terminal inspections; omitted from JSON when the feature is enabled but empty.

selected: Option<u64>

Selected element ID copied from caller state, whether or not it is present.

hovered: Option<u64>

Hovered element ID copied from caller state, whether or not it is present.

frame_index: u64

Opaque monotonically increasing frame identity supplied by the host.

Implementations

impl DebugSnapshot

Linear ID lookup helpers over snapshot nodes.

pub fn node(&self, id: u64) -> Option<&DebugNode>

Returns the first node with id, or None when absent.

Complexity is O(number of nodes).

Examples

use ailloli_ui_devtools_core::DebugSnapshot;
fn root_name(snapshot: &DebugSnapshot) -> Option<&str> {
    snapshot.node(snapshot.root).map(|node| node.widget_name.as_str())
}

pub fn node_mut(&mut self, id: u64) -> Option<&mut DebugNode>

Returns the first mutable node with id, or None when absent.

Complexity is O(number of nodes). Mutating geometry does not recompute warnings automatically; call compute_warnings afterward when needed.

Examples

use ailloli_ui_devtools_core::DebugSnapshot;
fn clear_node_warnings(snapshot: &mut DebugSnapshot, id: u64) {
    if let Some(node) = snapshot.node_mut(id) { node.warnings.clear(); }
}

Trait Implementations

impl Clone for DebugSnapshot

fn clone(&self) -> DebugSnapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DebugSnapshot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DebugSnapshot

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DebugSnapshot

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DebugSnapshot

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 DebugSnapshot