Skip to main content

N1DetectionScope

Struct N1DetectionScope 

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

Scope helper for N+1 detection tracking.

This helper captures the initial N+1 stats when created, allowing you to compare against final stats and log a summary of issues detected within the scope.

Note: This is NOT an automatic RAII guard - you must call log_summary() manually with the final stats. For automatic logging, wrap your code in a block and call log_summary at the end.

§Example

// Capture initial state
let scope = N1DetectionScope::from_tracker(session.n1_tracker());

// Do work that might cause N+1...
for hero in &mut heroes {
    hero.team.load(&mut session).await?;
}

// Manually log summary with final stats
scope.log_summary(&session.n1_stats());

Implementations§

Source§

impl N1DetectionScope

Source

pub fn new(initial_stats: N1Stats, threshold: usize) -> Self

Create a new detection scope.

This does NOT automatically enable detection on a Session - the caller should have already called session.enable_n1_detection(). This scope captures the initial state and logs a summary on drop.

§Arguments
  • initial_stats - The current N1Stats (from session.n1_stats())
  • threshold - The threshold being used for detection
Source

pub fn from_tracker(tracker: &N1QueryTracker) -> Self

Create a scope from a tracker reference.

Convenience method that extracts stats and threshold from an existing tracker.

Source

pub fn verbose(self) -> Self

Enable verbose logging (log summary even if no issues).

Source

pub fn log_summary(&self, final_stats: &N1Stats)

Log a summary of the detection results.

Called automatically on drop, but can be called manually for intermediate reporting.

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> 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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> Same for T

Source§

type Output = T

Should always be Self
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