Skip to main content

VariableMonitor

Struct VariableMonitor 

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

A lightweight per-frame named-variable display.

Call set(name, value) each frame; render() produces a formatted table string showing the current values.

Implementations§

Source§

impl VariableMonitor

Source

pub fn new() -> Self

Source

pub fn with_title(self, title: impl Into<String>) -> Self

Source

pub fn set(&mut self, name: impl Into<String>, value: impl Into<InspectorValue>)

Set or update the named variable.

Source

pub fn set_categorized( &mut self, name: impl Into<String>, value: impl Into<InspectorValue>, category: impl Into<String>, )

Set a variable with a category tag.

Source

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

Remove a named variable.

Source

pub fn clear(&mut self)

Clear all variables.

Source

pub fn render(&self) -> String

Format all variables as a display table.

Source

pub fn len(&self) -> usize

Number of variables registered.

Source

pub fn is_empty(&self) -> bool

Source

pub fn get(&self, name: &str) -> Option<&InspectorValue>

Get the current value of a named variable.

Trait Implementations§

Source§

impl Default for VariableMonitor

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<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, 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 = 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
Source§

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