Struct puffin::ScopeCollection

pub struct ScopeCollection(/* private fields */);

A collection of scope details containing more information about a recorded profile scope.

Implementations

impl ScopeCollection

pub fn fetch_by_id(&self, scope_id: &ScopeId) -> Option<&Arc<ScopeDetails>>

Fetches scope details by scope id.

pub fn fetch_by_name(&self, scope_name: &str) -> Option<&ScopeId>

Fetches scope details by scope name.

pub fn insert(&mut self, scope_details: Arc<ScopeDetails>) -> Arc<ScopeDetails>

Insert a scope into the collection. This method asserts the scope id is set which only puffin should do. Custom sinks might use this method to store new scope details received from puffin.

pub fn scopes_by_name(&self) -> &HashMap<Cow<'static, str>, ScopeId>

Fetches all registered scopes and their ids. Useful for fetching scope id by it’s scope name. For profiler scopes and user scopes this is the manual provided name. For function profiler scopes this is the function name.

pub fn scopes_by_id(&self) -> &HashMap<ScopeId, Arc<ScopeDetails>>

Fetches all registered scopes. Useful for fetching scope details by a scope id.

Trait Implementations

impl Clone for ScopeCollection

fn clone(&self) -> ScopeCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ScopeCollection

fn default() -> ScopeCollection

Returns the “default value” for a type.