Enum Scope 

#[repr(i32)]
pub enum Scope {
    Unspecified = 0,
    Global = 1,
    Cpu = 2,
}

The scope of a counter instance: which stream of values the per-sample weights belong to. Counter instances accumulate independently, so values from different instances must never be merged into one stream. Trace processor keeps sampling streams separate and materializes one counter track per instance within each stream: SCOPE_GLOBAL yields one track per sampling stream and SCOPE_CPU one track per (sampling stream, cpu).

If your profiler needs a scope that is not listed here, please file a bug at https://github.com/google/perfetto/issues explaining what you are trying to record and which scope you would like added. Append-only: never renumber or repurpose an existing value.

Variants

Unspecified = 0

Treated as SCOPE_GLOBAL.

Global = 1

A single counter instance, not split by cpu, thread or anything else.

Cpu = 2

One counter instance per cpu. Each sample’s weight belongs to the instance of the cpu in its ExecutionContext; samples without a cpu cannot be attributed and their weights for this counter are dropped.

Implementations

impl Scope

pub const fn is_valid(value: i32) -> bool

Returns true if value is a variant of Scope.

pub fn from_i32(value: i32) -> Option<Scope>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a Scope, or None if value is not a valid variant.

impl Scope

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Scope

impl Debug for Scope

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

Formats the value using the given formatter.

impl Default for Scope

fn default() -> Scope

Returns the “default value” for a type.

impl Eq for Scope

impl From<Scope> for i32

fn from(value: Scope) -> i32

Converts to this type from the input type.

impl Hash for Scope

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 Scope

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Scope

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Scope

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Scope

impl TryFrom<i32> for Scope

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Scope, UnknownEnumValue>

Performs the conversion.