DebugCommand

Enum DebugCommand 

Source
#[non_exhaustive]
pub enum DebugCommand {
Show 39 variants InspectEntity { entity_id: EntityId, include_metadata: Option<bool>, include_relationships: Option<bool>, }, InspectBatch { entity_ids: Vec<EntityId>, include_metadata: Option<bool>, include_relationships: Option<bool>, limit: Option<usize>, }, ProfileSystem { system_name: String, duration_ms: Option<u64>, track_allocations: Option<bool>, }, SetVisualDebug { overlay_type: DebugOverlayType, enabled: bool, config: Option<Value>, }, ExecuteQuery { query: ValidatedQuery, offset: Option<usize>, limit: Option<usize>, }, ValidateQuery { params: Value, }, EstimateCost { params: Value, }, GetQuerySuggestions { params: Value, }, BuildAndExecuteQuery { params: Value, }, ProfileMemory { capture_backtraces: Option<bool>, target_systems: Option<Vec<String>>, duration_seconds: Option<u64>, }, StopMemoryProfiling { session_id: Option<String>, }, GetMemoryProfile, DetectMemoryLeaks { target_systems: Option<Vec<String>>, }, AnalyzeMemoryTrends { target_systems: Option<Vec<String>>, }, TakeMemorySnapshot, GetMemoryStatistics, SessionControl { operation: SessionOperation, session_id: Option<String>, }, GetStatus, GetHierarchy { root_entity: Option<EntityId>, max_depth: Option<usize>, }, GetSystemInfo { system_name: Option<String>, include_scheduling: Option<bool>, }, StartIssueDetection, StopIssueDetection, GetDetectedIssues { limit: Option<usize>, }, AcknowledgeIssue { alert_id: String, }, ReportFalsePositive { alert_id: String, }, GetIssueDetectionStats, UpdateDetectionRule { name: String, enabled: Option<bool>, sensitivity: Option<f32>, }, ClearIssueHistory, StartBudgetMonitoring, StopBudgetMonitoring, SetPerformanceBudget { config: Value, }, GetPerformanceBudget, CheckBudgetViolations, GetBudgetViolationHistory { limit: Option<usize>, }, GenerateComplianceReport { duration_seconds: Option<u64>, }, GetBudgetRecommendations, ClearBudgetHistory, GetBudgetStatistics, Custom { name: String, params: Value, },
}
Expand description

Debug command types for extensible debugging operations

Variants (Non-exhaustive)§

This enum is marked as 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.
§

InspectEntity

Inspect entity with detailed component information

Fields

§entity_id: EntityId
§include_metadata: Option<bool>

Include component metadata

§include_relationships: Option<bool>

Include parent/child relationships

§

InspectBatch

Inspect multiple entities in a single batch operation

Fields

§entity_ids: Vec<EntityId>
§include_metadata: Option<bool>

Include component metadata for all entities

§include_relationships: Option<bool>

Include parent/child relationships for all entities

§limit: Option<usize>

Maximum number of entities to inspect (default: 100)

§

ProfileSystem

Profile system performance

Fields

§system_name: String

System name to profile

§duration_ms: Option<u64>

Duration in milliseconds

§track_allocations: Option<bool>

Include memory allocations

§

SetVisualDebug

Enable/disable visual debugging overlays

Fields

§overlay_type: DebugOverlayType

Type of overlay

§enabled: bool

Enable or disable

§config: Option<Value>

Optional configuration

§

ExecuteQuery

Execute a validated ECS query

Fields

§query: ValidatedQuery

Validated query structure

§offset: Option<usize>

Pagination offset

§limit: Option<usize>

Results limit

§

ValidateQuery

Validate a query without executing it

Fields

§params: Value

Query parameters as JSON

§

EstimateCost

Estimate the cost of executing a query

Fields

§params: Value

Query parameters as JSON

§

GetQuerySuggestions

Get optimization suggestions for a query

Fields

§params: Value

Query parameters as JSON

§

BuildAndExecuteQuery

Build and execute a query using the query builder

Fields

§params: Value

Query parameters as JSON

§

ProfileMemory

Memory profiling command

Fields

§capture_backtraces: Option<bool>

Capture allocation backtraces

§target_systems: Option<Vec<String>>

Track specific systems

§duration_seconds: Option<u64>

Duration in seconds for profiling session

§

StopMemoryProfiling

Stop memory profiling session

Fields

§session_id: Option<String>

Session ID to stop (None for default session)

§

GetMemoryProfile

Get current memory profile

§

DetectMemoryLeaks

Detect memory leaks

Fields

§target_systems: Option<Vec<String>>

Target systems to check for leaks

§

AnalyzeMemoryTrends

Analyze memory usage trends

Fields

§target_systems: Option<Vec<String>>

Target systems to analyze

§

TakeMemorySnapshot

Take a memory snapshot

§

GetMemoryStatistics

Get memory profiler statistics

§

SessionControl

Session management

Fields

§operation: SessionOperation

Session operation

§session_id: Option<String>

Session ID

§

GetStatus

Get debug system status

§

GetHierarchy

Get entity hierarchy information

Fields

§root_entity: Option<EntityId>

Optional root entity to start from

§max_depth: Option<usize>

Maximum depth to traverse

§

GetSystemInfo

Get system information and metadata

Fields

§system_name: Option<String>

Optional system name filter

§include_scheduling: Option<bool>

Include scheduling information

§

StartIssueDetection

Start automated issue detection monitoring

§

StopIssueDetection

Stop automated issue detection monitoring

§

GetDetectedIssues

Get detected issues/alerts

Fields

§limit: Option<usize>

Maximum number of issues to return

§

AcknowledgeIssue

Acknowledge an issue alert

Fields

§alert_id: String

Alert ID to acknowledge

§

ReportFalsePositive

Report an alert as a false positive

Fields

§alert_id: String

Alert ID to mark as false positive

§

GetIssueDetectionStats

Get issue detection statistics

§

UpdateDetectionRule

Update a detection rule configuration

Fields

§name: String

Rule name to update

§enabled: Option<bool>

Enable/disable the rule

§sensitivity: Option<f32>

Sensitivity level (0.0 to 1.0)

§

ClearIssueHistory

Clear issue alert history

§

StartBudgetMonitoring

Start performance budget monitoring

§

StopBudgetMonitoring

Stop performance budget monitoring

§

SetPerformanceBudget

Set performance budget configuration

Fields

§config: Value

Budget configuration as JSON

§

GetPerformanceBudget

Get current performance budget configuration

§

CheckBudgetViolations

Check for current budget violations

§

GetBudgetViolationHistory

Get budget violation history

Fields

§limit: Option<usize>

Maximum number of violations to return

§

GenerateComplianceReport

Generate compliance report for specified duration

Fields

§duration_seconds: Option<u64>

Duration in seconds (default: 3600 = 1 hour)

§

GetBudgetRecommendations

Get budget recommendations based on historical data

§

ClearBudgetHistory

Clear budget violation history

§

GetBudgetStatistics

Get budget monitoring statistics

§

Custom

Custom debug command for extensions

Fields

§name: String

Command name

§params: Value

Command parameters

Trait Implementations§

Source§

impl Clone for DebugCommand

Source§

fn clone(&self) -> DebugCommand

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DebugCommand

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DebugCommand

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for DebugCommand

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,