Struct puffin::ScopeDetails

pub struct ScopeDetails {
    pub scope_name: Option<Cow<'static, str>>,
    pub function_name: Cow<'static, str>,
    pub file_path: Cow<'static, str>,
    pub line_nr: u32,
    /* private fields */
}

Detailed information about a scope.

Fields

scope_name: Option<Cow<'static, str>>

A name for a profile scope, a function profile scope does not have a custom provided name.

function_name: Cow<'static, str>

The function name of the function in which this scope is contained. The name might be slightly modified to represent a short descriptive representation.

file_path: Cow<'static, str>

The file path in which this scope is contained. The path might be slightly modified to represent a short descriptive representation.

line_nr: u32

The exact line number at which this scope is located.

Implementations

impl ScopeDetails

pub fn from_scope_name<T>(scope_name: T) -> Self

where T: Into<Cow<'static, str>>,

Creates a new user scope with a unique name.

pub fn with_function_name<T>(self, name: T) -> Self

where T: Into<Cow<'static, str>>,

Scope in a function.

pub fn with_file<T>(self, file: T) -> Self

where T: Into<Cow<'static, str>>,

Scope in a file.

pub fn with_line_nr(self, line_nr: u32) -> Self

Scope at a line number.

pub fn name(&self) -> &Cow<'static, str>

Returns the scope name if this is a profile scope or else the function name.

pub fn scope_type(&self) -> ScopeType

Returns what type of scope this is.

pub fn location(&self) -> String

Returns the exact location of the profile scope formatted as file:line_nr

Trait Implementations

impl Clone for ScopeDetails

fn clone(&self) -> ScopeDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeDetails

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

Formats the value using the given formatter.

impl Default for ScopeDetails

fn default() -> ScopeDetails

Returns the “default value” for a type.

impl Hash for ScopeDetails

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ScopeDetails

fn cmp(&self, other: &ScopeDetails) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ScopeDetails

fn eq(&self, other: &ScopeDetails) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ScopeDetails

fn partial_cmp(&self, other: &ScopeDetails) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ScopeDetails

impl StructuralPartialEq for ScopeDetails