Struct puffin::FrameView

pub struct FrameView { /* private fields */ }

A view of recent and slowest frames, used by GUIs.

Implementations

impl FrameView

pub fn is_empty(&self) -> bool

Returns true if there are no recent or slowest frames.

pub fn scope_collection(&self) -> &ScopeCollection

Returns the collection of scope details. This can be used to fetch more information about a specific scope.

pub fn add_frame(&mut self, new_frame: Arc<FrameData>)

Adds a new frame to the view.

pub fn latest_frame(&self) -> Option<Arc<FrameData>>

The latest fully captured frame of data.

pub fn latest_frames(&self, n: usize) -> Vec<Arc<FrameData>>

Returns up to n latest fully captured frames of data.

pub fn recent_frames(&self) -> impl Iterator<Item = &Arc<FrameData>>

Oldest first

pub fn slowest_frames_chronological(&self) -> Vec<Arc<FrameData>>

The slowest frames so far (or since last call to Self::clear_slowest()) in chronological order.

pub fn all_uniq(&self) -> Vec<Arc<FrameData>>

All frames sorted chronologically.

pub fn clear_slowest(&mut self)

Clean history of the slowest frames.

pub fn max_recent(&self) -> usize

How many frames of recent history to store.

pub fn set_max_recent(&mut self, max_recent: usize)

How many frames of recent history to store.

pub fn max_slow(&self) -> usize

How many slow “spike” frames to store.

pub fn set_max_slow(&mut self, max_slow: usize)

How many slow “spike” frames to store.

pub fn pack_frames(&self) -> bool

Returns if frames are packed (compressed).

pub fn set_pack_frames(&mut self, pack_frames: bool)

Sets wether frames should be packed (compressed). Packing frames will increase CPU time and decrease memory usage.

Trait Implementations

impl Clone for FrameView

fn clone(&self) -> FrameView

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for FrameView

fn default() -> Self

Returns the “default value” for a type.