Struct LogPlugin 

pub struct LogPlugin {
    pub filter: String,
    pub level: LogLevel,
    pub custom_layer: fn(app: &mut App) -> Option<Box<dyn Layer<Registry> + Send + Sync + 'static>>,
    pub fmt_layer: fn(app: &mut App) -> Option<Box<dyn Layer<Layered<EnvFilter, Layered<Option<Box<dyn Layer<Registry> + Send + Sync>>, Registry>>> + Send + Sync + 'static>>,
    pub log_file: PathBuf,
}

Plugin that configures logging for WaterDropEngine applications.

Configuration

The RUST_LOG environment variable overrides plugin settings and uses [EnvFilter] syntax. Set NO_COLOR=1 to disable colored output (see no-color.org).

Log Levels

Available log levels (most to least important):

• error!() - Critical failures
• warn!() - Important warnings
• info!() - General information
• debug!() - Debug information
• trace!() - Verbose tracing

Fields

filter: String

Filters logs using the [EnvFilter] format

level: LogLevel

Filters out logs that are “less than” the given level. This can be further filtered using the filter setting.

custom_layer: fn(app: &mut App) -> Option<Box<dyn Layer<Registry> + Send + Sync + 'static>>

Optionally add an extra [Layer] to the tracing subscriber.

fmt_layer: fn(app: &mut App) -> Option<Box<dyn Layer<Layered<EnvFilter, Layered<Option<Box<dyn Layer<Registry> + Send + Sync>>, Registry>>> + Send + Sync + 'static>>

Override the default [tracing_subscriber::fmt::Layer] with a custom one. For example, you can use [tracing_subscriber::fmt::Layer::without_time] to remove the timestamp from the log output.

log_file: PathBuf

Path of the file logs are written to. The previous log file, if any, is renamed alongside it with a -old suffix before its extension (e.g. log.txt -> log-old.txt).

Defaults to <temp_dir>/waterdropengine/log.txt.

Implementations

impl LogPlugin

pub fn auto_level(self) -> Self

Sets the log level based on debug/release mode.

pub fn with_crate_level(self, target: &str, level: LogLevel) -> Self

Overrides the log level for a specific crate/module target, regardless of the global level.

This is useful to keep the engine’s own logs quiet (e.g. LogLevel::INFO) while enabling more verbose logging (e.g. LogLevel::DEBUG) for your own game/application crate.

target should be the crate’s module path as used by tracing (i.e. the crate name with - replaced by _), such as "my_game".

Trait Implementations

impl Default for LogPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for LogPlugin

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.