Skip to main content

Profiler

Struct Profiler 

Source
pub struct Profiler {
    pub enabled: bool,
    pub frame_history: VecDeque<FrameProfile>,
    pub max_history: usize,
    pub current_frame: Option<FrameProfile>,
    pub frame_counter: u64,
    pub budget: PerformanceBudget,
    pub budget_violations: Vec<BudgetReport>,
    pub stats: HashMap<String, StatRingBuffer>,
    pub capture_flamegraph: bool,
    pub flamegraph_history: VecDeque<FlamegraphNode>,
    /* private fields */
}

Fields§

§enabled: bool§frame_history: VecDeque<FrameProfile>§max_history: usize§current_frame: Option<FrameProfile>§frame_counter: u64§budget: PerformanceBudget§budget_violations: Vec<BudgetReport>§stats: HashMap<String, StatRingBuffer>§capture_flamegraph: bool§flamegraph_history: VecDeque<FlamegraphNode>

Implementations§

Source§

impl Profiler

Source

pub fn new() -> Self

Source

pub fn register_stat(&mut self, name: &str, unit: CounterUnit, capacity: usize)

Source

pub fn advance_sim_time(&mut self, us: u64)

Source

pub fn begin_frame(&mut self)

Source

pub fn end_frame(&mut self, frame_ms: f64)

Source

pub fn begin_span(&mut self, name: &str, kind: SpanKind) -> SpanId

Source

pub fn end_span(&mut self, id: SpanId)

Source

pub fn record_counter(&mut self, name: &str, value: f64, unit: CounterUnit)

Source

pub fn record_memory(&mut self, mem: MemorySnapshot)

Source

pub fn fps(&self) -> f64

Source

pub fn frame_ms(&self) -> f64

Source

pub fn mean_fps(&self) -> f64

Source

pub fn p95_frame_ms(&self) -> f64

Source

pub fn latest_frame(&self) -> Option<&FrameProfile>

Source

pub fn latest_flamegraph(&self) -> Option<&FlamegraphNode>

Source

pub fn stat(&self, name: &str) -> Option<&StatRingBuffer>

Source

pub fn summary_line(&self) -> String

Source

pub fn detailed_summary(&self) -> String

Source

pub fn reset_stats(&mut self)

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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