Skip to main content

msg_debug

kasl

Macro msg_debug 

Source 
macro_rules! msg_debug {
    ($msg:expr) => { ... };
}
Expand description

Debug-only message display with 🔍 prefix.

This macro provides debug-specific logging that only appears when debug mode is explicitly enabled. Debug messages are useful for troubleshooting and development but are hidden from normal users to avoid clutter.

§Debug-Only Behavior

  • Debug Mode: Messages are displayed using tracing::debug!
  • Normal Mode: Messages are completely suppressed (no output)
  • Performance: No overhead in production builds when debug is disabled

§Visual Design

  • Prefix: 🔍 (magnifying glass emoji)
  • Purpose: Development and troubleshooting information
  • Audience: Developers and power users debugging issues

§Debug Message Categories

Debug messages are appropriate for:

  • Technical Details: Low-level system information
  • State Changes: Internal state transitions and updates
  • Performance Metrics: Timing and performance measurements
  • Data Flow: How data moves through the system
  • Error Context: Additional context for debugging errors

§Usage Patterns

§Technical Debug Information

use kasl::msg_debug;

let task_id = 42;
msg_debug!(format!("Processing task with ID: {}", task_id));
// Debug mode output: "🔍 Processing task with ID: 42"
// Normal mode output: (nothing)

§State Change Debugging

use kasl::msg_debug;

let old_state = "Active";
let new_state = "InPause";
msg_debug!(format!("State transition: {:?} -> {:?}", old_state, new_state));
// Debug mode output: "🔍 State transition: Active -> InPause"
// Normal mode output: (nothing)