Skip to main content

Profiler

Struct Profiler 

Source
pub struct Profiler {
    pub enabled: bool,
    pub events: Vec<(u64, ProfilingEvent)>,
    pub call_stack: Vec<(String, u64)>,
}
Expand description

Lightweight profiler that records events for later analysis.

Fields§

§enabled: bool

Whether profiling is currently active.

§events: Vec<(u64, ProfilingEvent)>

Recorded events as (timestamp_ns, event) pairs.

§call_stack: Vec<(String, u64)>

Stack of (function_name, entry_timestamp_ns) entries.

Implementations§

Source§

impl Profiler

Source

pub fn new() -> Self

Create a new, disabled profiler.

Source

pub fn enable(&mut self)

Enable profiling.

Source

pub fn disable(&mut self)

Disable profiling.

Source

pub fn record(&mut self, event: ProfilingEvent)

Record an arbitrary profiling event (no-op when disabled).

Source

pub fn enter_function(&mut self, name: &str)

Record a function entry and push it onto the call stack.

Source

pub fn exit_function(&mut self, name: &str)

Record a function exit and pop it from the call stack.

Source

pub fn alloc(&mut self, size: usize, tag: &str)

Record a memory allocation.

Source

pub fn dealloc(&mut self, size: usize, tag: &str)

Record a memory deallocation.

Source

pub fn gc_cycle(&mut self, collected: usize, live: usize)

Record a GC cycle.

Source

pub fn generate_report(&self) -> ProfileReport

Generate a report from the recorded events.

Source

pub fn memory_profile(&self) -> MemoryProfile

Generate a memory profile from the recorded events.

Trait Implementations§

Source§

impl Default for Profiler

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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