#[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>>, }
Expand description

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

Fields (Non-exhaustive)§

This struct is marked as 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§

source§

impl Pattern

source

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

The universally unique identifier (UUID) of this pattern.

source

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

The name for this pattern.

source

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

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

source

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

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

source

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().

source

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.

source

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().

source§

impl Pattern

source

pub fn builder() -> PatternBuilder

Creates a new builder-style object to manufacture Pattern.

Trait Implementations§

source§

impl Clone for Pattern

source§

fn clone(&self) -> Pattern

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Pattern

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for Pattern

source§

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

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

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.
source§

impl StructuralPartialEq for Pattern

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Unshared, Shared> IntoShared<Shared> for Unsharedwhere Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more