Enum DebugResponse 

#[non_exhaustive]
pub enum DebugResponse {
    EntityInspection {
        entity: EntityData,
        metadata: Option<EntityMetadata>,
        relationships: Option<EntityRelationships>,
    },
    BatchEntityInspection {
        entities: Vec<EntityInspectionResult>,
        requested_count: usize,
        found_count: usize,
        missing_entities: Vec<EntityId>,
        inspection_time_us: u64,
    },
    SystemProfile(SystemProfile),
    ProfilingStarted {
        system_name: String,
        duration_ms: Option<u64>,
    },
    ProfileHistory {
        system_name: String,
        samples: Vec<ProfileSample>,
        frame_count: usize,
    },
    PerformanceAnomalies {
        count: usize,
        anomalies: Vec<Value>,
    },
    VisualDebugStatus {
        overlay_type: DebugOverlayType,
        enabled: bool,
        config: Option<Value>,
    },
    QueryResult {
        entities: Vec<EntityData>,
        total_count: usize,
        execution_time_us: u64,
        has_more: bool,
    },
    MemoryProfile {
        total_allocated: usize,
        allocations_per_system: HashMap<String, usize>,
        top_allocations: Vec<AllocationInfo>,
    },
    SessionStatus {
        session_id: String,
        state: SessionState,
        command_count: usize,
        checkpoints: Vec<CheckpointInfo>,
    },
    Status {
        version: String,
        active_sessions: usize,
        command_queue_size: usize,
        performance_overhead_percent: f32,
    },
    QueryValidation {
        valid: bool,
        query: Option<ValidatedQuery>,
        errors: Vec<String>,
        suggestions: Vec<String>,
    },
    QueryCost {
        cost: QueryCost,
        performance_budget_exceeded: bool,
        suggestions: Vec<String>,
    },
    QuerySuggestions {
        suggestions: Vec<String>,
        query_complexity: u32,
    },
    QueryExecution {
        success: bool,
        result: Option<Box<BrpResponse>>,
        execution_time_us: u64,
        entities_processed: Option<usize>,
    },
    Success {
        message: String,
        data: Option<Value>,
    },
    Custom(Value),
}

Debug response types

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

EntityInspection

Entity inspection result

Fields

entity: EntityData

metadata: Option<EntityMetadata>

relationships: Option<EntityRelationships>

BatchEntityInspection

Batch entity inspection result

Fields

entities: Vec<EntityInspectionResult>

requested_count: usize

Total entities requested

found_count: usize

Successfully inspected entities

missing_entities: Vec<EntityId>

Entities that were not found (despawned)

inspection_time_us: u64

Total inspection time in microseconds

SystemProfile(SystemProfile)

System profiling result

ProfilingStarted

Profiling started response

Fields

system_name: String

duration_ms: Option<u64>

ProfileHistory

Profiling history response

Fields

system_name: String

samples: Vec<ProfileSample>

frame_count: usize

PerformanceAnomalies

Performance anomalies response

Fields

count: usize

anomalies: Vec<Value>

VisualDebugStatus

Visual debug status

Fields

overlay_type: DebugOverlayType

enabled: bool

config: Option<Value>

QueryResult

Query execution result

Fields

entities: Vec<EntityData>

total_count: usize

execution_time_us: u64

has_more: bool

MemoryProfile

Memory profile result

Fields

total_allocated: usize

allocations_per_system: HashMap<String, usize>

top_allocations: Vec<AllocationInfo>

SessionStatus

Session control result

Fields

session_id: String

state: SessionState

command_count: usize

checkpoints: Vec<CheckpointInfo>

Status

Debug system status

Fields

version: String

active_sessions: usize

command_queue_size: usize

performance_overhead_percent: f32

QueryValidation

Query validation result

Fields

valid: bool

query: Option<ValidatedQuery>

errors: Vec<String>

suggestions: Vec<String>

QueryCost

Query cost estimation result

Fields

cost: QueryCost

performance_budget_exceeded: bool

suggestions: Vec<String>

QuerySuggestions

Query optimization suggestions

Fields

suggestions: Vec<String>

query_complexity: u32

QueryExecution

Query execution result

Fields

success: bool

result: Option<Box<BrpResponse>>

execution_time_us: u64

entities_processed: Option<usize>

Success

Generic success response

Fields

message: String

data: Option<Value>

Custom(Value)

Custom debug response

Trait Implementations

impl Clone for DebugResponse

fn clone(&self) -> DebugResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DebugResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DebugResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DebugResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.