Struct Pattern

#[non_exhaustive]
pub struct Pattern {
    pub id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub resolution_steps: Option<String>,
    pub target_frames: Option<Vec<Vec<String>>>,
    pub threshold_percent: f64,
    pub counters_to_aggregate: Option<Vec<String>>,
}

A set of rules used to make a recommendation during an analysis.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The universally unique identifier (UUID) of this pattern.

name: Option<String>

The name for this pattern.

description: Option<String>

The description of the recommendation. This explains a potential inefficiency in a profiled application.

resolution_steps: Option<String>

A string that contains the steps recommended to address the potential inefficiency.

target_frames: Option<Vec<Vec<String>>>

A list of frame names that were searched during the analysis that generated a recommendation.

threshold_percent: f64

The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis.

counters_to_aggregate: Option<Vec<String>>

A list of the different counters used to determine if there is a match.

Implementations

impl Pattern

pub fn id(&self) -> Option<&str>

The universally unique identifier (UUID) of this pattern.

pub fn name(&self) -> Option<&str>

The name for this pattern.

pub fn description(&self) -> Option<&str>

The description of the recommendation. This explains a potential inefficiency in a profiled application.

pub fn resolution_steps(&self) -> Option<&str>

A string that contains the steps recommended to address the potential inefficiency.

pub fn target_frames(&self) -> &[Vec<String>]

A list of frame names that were searched during the analysis that generated a recommendation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_frames.is_none().

pub fn threshold_percent(&self) -> f64

The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis.

pub fn counters_to_aggregate(&self) -> &[String]

A list of the different counters used to determine if there is a match.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .counters_to_aggregate.is_none().

impl Pattern

pub fn builder() -> PatternBuilder

Creates a new builder-style object to manufacture Pattern.

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl PartialEq for Pattern

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Pattern