Skip to main content

DevToolsState

Struct DevToolsState 

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

Everything the inspector displays, and the only mutable state it owns.

Installed once with DevToolsState::init; feed it through the free functions in crate::devtools (console_log, network_begin, …), which are no-ops when it was never installed. That is deliberate: instrumentation left in a release build costs a global lookup and nothing more.

Implementations§

Source§

impl DevToolsState

Source

pub fn new() -> Self

Source

pub fn limits(self, limits: Limits) -> Self

Source

pub fn init(self, cx: &mut App)

Install as the app global. Call once at startup, before opening crate::devtools::DevTools.

Source

pub fn generation(&self) -> u64

Bumped on every mutation, so a panel can tell “nothing changed” cheaply.

Source

pub fn now(&self) -> Duration

Time since the store was created — the clock every record is stamped on.

Source

pub fn push_log(&mut self, record: LogRecord)

Append a line, coalescing it into the previous one when identical.

Source

pub fn logs(&self) -> &VecDeque<LogRecord>

Source

pub fn clear_logs(&mut self)

Source

pub fn log_issues(&self) -> (usize, usize)

Warning and error tallies for the toolbar badges.

Source

pub fn push_network(&mut self, record: NetworkRecord) -> u64

Record a request that has started. Returns its id, which the host keeps to settle the request later.

Source

pub fn update_network(&mut self, id: u64, f: impl FnOnce(&mut NetworkRecord))

Amend a request in flight — the response landed, the transfer grew, it failed. Silently does nothing if the record was already evicted.

Source

pub fn network(&self) -> &VecDeque<NetworkRecord>

Source

pub fn clear_network(&mut self)

Source

pub fn network_span(&self) -> (Duration, Duration)

The window the waterfall is drawn against: earliest start to latest end.

Source

pub fn network_totals(&self) -> (usize, u64, u64)

Row count, total transfer, and total resource bytes — the status bar.

Source

pub fn set_storage(&mut self, domain: StorageDomain)

Register a domain, replacing any existing one with the same id. Hosts call this whenever their store changes; the panel always shows the latest snapshot.

Source

pub fn remove_storage(&mut self, id: &str)

Source

pub fn storage(&self) -> &[StorageDomain]

Source

pub fn push_timeline(&mut self, event: TimelineEvent)

Source

pub fn timeline(&self) -> &VecDeque<TimelineEvent>

Source

pub fn clear_timeline(&mut self)

Source

pub fn record_frame(&mut self)

Called once per rendered frame by the inspector itself. Deriving the interval here — rather than asking the host to report it — is what makes the Frames band work with no wiring at all.

Source

pub fn stop_frames(&mut self)

Forget where the last frame landed. Called when recording stops so the idle gap before it resumes is not measured as one enormous frame.

Source

pub fn frames(&self) -> &VecDeque<Duration>

Source

pub fn fps(&self) -> Option<f32>

Frames per second over the recorded window, or None before the second frame has been seen.

Source

pub fn clear_all(&mut self)

Drop every record. The toolbar’s clear button, and what a host calls when it wants a clean slate around a reproduction.

Trait Implementations§

Source§

impl Default for DevToolsState

Source§

fn default() -> Self

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

impl Global for DevToolsState

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ReadGlobal for T
where T: Global,

Source§

fn global(cx: &App) -> &T

Returns the global instance of the implementing type. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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 = !

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> UpdateGlobal for T
where T: Global,

Source§

fn update_global<C, F, R>(cx: &mut C, update: F) -> R
where C: BorrowAppContext, F: FnOnce(&mut T, &mut C) -> R,

Updates the global instance of the implementing type using the provided closure. Read more
Source§

fn set_global<C>(cx: &mut C, global: T)

Set the global instance of the implementing type.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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