Enum ProfileType 

#[non_exhaustive]
pub enum ProfileType {
    Unspecified,
    Cpu,
    Wall,
    Heap,
    Threads,
    Contention,
    PeakHeap,
    HeapAlloc,
    UnknownValue(UnknownValue),
}

ProfileType is type of profiling data. NOTE: the enumeration member names are used (in lowercase) as unique string identifiers of profile types, so they must not be renamed.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

Unspecified profile type.

Cpu

Thread CPU time sampling.

Wall

Wallclock time sampling. More expensive as stops all threads.

Heap

In-use heap profile. Represents a snapshot of the allocations that are live at the time of the profiling.

Threads

Single-shot collection of all thread stacks.

Contention

Synchronization contention profile.

PeakHeap

Peak heap profile.

HeapAlloc

Heap allocation profile. It represents the aggregation of all allocations made over the duration of the profile. All allocations are included, including those that might have been freed by the end of the profiling interval. The profile is in particular useful for garbage collecting languages to understand which parts of the code create most of the garbage collection pressure to see if those can be optimized.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using ProfileType::value or ProfileType::name.

Implementations

impl ProfileType

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

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

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for ProfileType

fn clone(&self) -> ProfileType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProfileType

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

Formats the value using the given formatter.

impl Default for ProfileType

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProfileType

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProfileType

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

Formats the value using the given formatter.

impl From<&str> for ProfileType

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for ProfileType

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for ProfileType

fn eq(&self, other: &ProfileType) -> 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 Serialize for ProfileType

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProfileType