ActionLoggerMiddleware

Struct ActionLoggerMiddleware 

Source
pub struct ActionLoggerMiddleware { /* private fields */ }
Expand description

Middleware that logs actions with configurable pattern filtering.

Supports two modes:

  • Tracing only (default): logs via tracing::debug!()
  • With storage: also stores in ActionLog ring buffer for overlay display

§Example

use tui_dispatch_core::debug::{ActionLoggerConfig, ActionLoggerMiddleware, ActionLogConfig};
use tui_dispatch_core::{Store, StoreWithMiddleware};

// Tracing only
let middleware = ActionLoggerMiddleware::new(ActionLoggerConfig::default());

// With in-memory storage
let middleware = ActionLoggerMiddleware::with_log(ActionLogConfig::default());

// Access the log for display
if let Some(log) = middleware.log() {
    for entry in log.recent(10) {
        println!("{}", entry.params);
    }
}

Implementations§

Source§

impl ActionLoggerMiddleware

Source

pub fn new(config: ActionLoggerConfig) -> Self

Create a new action logger middleware with tracing only (no in-memory storage)

Source

pub fn with_log(config: ActionLogConfig) -> Self

Create middleware with in-memory storage

Source

pub fn with_default_log() -> Self

Create with default config and in-memory storage

Source

pub fn default_filtering() -> Self

Create with default config (excludes Tick and Render), tracing only

Source

pub fn log_all() -> Self

Create with no filtering (logs all actions), tracing only

Source

pub fn active(self, active: bool) -> Self

Set whether the middleware is active.

When inactive (false), all methods become no-ops with zero overhead. This is useful for conditional logging based on CLI flags.

§Example
let middleware = ActionLoggerMiddleware::default_filtering()
    .active(args.debug);  // Only log if --debug flag passed
Source

pub fn is_active(&self) -> bool

Check if the middleware is active.

Source

pub fn log(&self) -> Option<&ActionLog>

Get the action log (if storage is enabled)

Source

pub fn log_mut(&mut self) -> Option<&mut ActionLog>

Get mutable action log

Source

pub fn config(&self) -> &ActionLoggerConfig

Get a reference to the config

Source

pub fn config_mut(&mut self) -> &mut ActionLoggerConfig

Get a mutable reference to the config

Trait Implementations§

Source§

impl Clone for ActionLoggerMiddleware

Source§

fn clone(&self) -> ActionLoggerMiddleware

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 ActionLoggerMiddleware

Source§

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

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

impl<A: ActionParams> Middleware<A> for ActionLoggerMiddleware

Source§

fn before(&mut self, action: &A)

Called before the action is dispatched to the reducer
Source§

fn after(&mut self, _action: &A, _state_changed: bool)

Called after the action is processed by the reducer

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> 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<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