Struct bevy_diagnostic::Diagnostic

source ·
pub struct Diagnostic {
    pub suffix: Cow<'static, str>,
    pub is_enabled: bool,
    /* private fields */
}
Expand description

A timeline of DiagnosticMeasurements of a specific type. Diagnostic examples: frames per second, CPU usage, network latency

Fields§

§suffix: Cow<'static, str>§is_enabled: bool

Implementations§

source§

impl Diagnostic

source

pub fn add_measurement(&mut self, measurement: DiagnosticMeasurement)

Add a new value as a DiagnosticMeasurement.

source

pub fn new(path: DiagnosticPath) -> Diagnostic

Create a new diagnostic with the given path.

source

pub fn with_max_history_length(self, max_history_length: usize) -> Self

Set the maximum history length.

source

pub fn with_suffix(self, suffix: impl Into<Cow<'static, str>>) -> Self

Add a suffix to use when logging the value, can be used to show a unit.

source

pub fn with_smoothing_factor(self, smoothing_factor: f64) -> Self

The smoothing factor used for the exponential smoothing used for smoothed.

If measurements come in less frequently than smoothing_factor seconds apart, no smoothing will be applied. As measurements come in more frequently, the smoothing takes a greater effect such that it takes approximately smoothing_factor seconds for 83% of an instantaneous change in measurement to e reflected in the smoothed value.

A smoothing factor of 0.0 will effectively disable smoothing.

source

pub fn path(&self) -> &DiagnosticPath

source

pub fn measurement(&self) -> Option<&DiagnosticMeasurement>

Get the latest measurement from this diagnostic.

source

pub fn value(&self) -> Option<f64>

Get the latest value from this diagnostic.

source

pub fn average(&self) -> Option<f64>

Return the simple moving average of this diagnostic’s recent values. N.B. this a cheap operation as the sum is cached.

source

pub fn smoothed(&self) -> Option<f64>

Return the exponential moving average of this diagnostic.

This is by default tuned to behave reasonably well for a typical measurement that changes every frame such as frametime. This can be adjusted using with_smoothing_factor.

source

pub fn history_len(&self) -> usize

Return the number of elements for this diagnostic.

source

pub fn duration(&self) -> Option<Duration>

Return the duration between the oldest and most recent values for this diagnostic.

source

pub fn get_max_history_length(&self) -> usize

Return the maximum number of elements for this diagnostic.

source

pub fn values(&self) -> impl Iterator<Item = &f64>

source

pub fn measurements(&self) -> impl Iterator<Item = &DiagnosticMeasurement>

source

pub fn clear_history(&mut self)

Clear the history of this diagnostic.

Trait Implementations§

source§

impl Debug for Diagnostic

source§

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

Formats the value using the given formatter. 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> 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 + Sync + Send>

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<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, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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

impl<T> ConditionalSend for T
where T: Send,