Struct LogDiagnosticsPlugin

pub struct LogDiagnosticsPlugin {
    pub debug: bool,
    pub wait_duration: Duration,
    pub filter: Option<Vec<DiagnosticPath>>,
}

An App Plugin that logs diagnostics to the console.

Diagnostics are collected by plugins such as FrameTimeDiagnosticsPlugin or can be provided by the user.

When no diagnostics are provided, this plugin does nothing.

Fields

debug: bool

wait_duration: Duration

filter: Option<Vec<DiagnosticPath>>

Implementations

impl LogDiagnosticsPlugin

pub fn filtered(filter: Vec<DiagnosticPath>) -> Self

Trait Implementations

impl Default for LogDiagnosticsPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for LogDiagnosticsPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.