Enum ProfileMode

#[non_exhaustive]
pub enum ProfileMode {
    HeapSummaryAllocated,
    HeapSummaryRetained,
    HeapFlameAllocated,
    HeapFlameRetained,
    Statement,
    Coverage,
    Bytecode,
    BytecodePairs,
    TimeFlame,
    Typecheck,
    None,
}

How to profile starlark code.

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.

HeapSummaryAllocated

The heap profile mode provides information about the time spent in each function and allocations performed by each function. Enabling this mode has the side effect of disabling garbage-collection. This profiling mode is the recommended one.

HeapSummaryRetained

Like heap summary, but information about retained memory after module is frozen.

HeapFlameAllocated

Like heap profile, but writes output comparible with flamegraph.pl.

HeapFlameRetained

Like heap flame, but information about retained memory after module is frozen.

Statement

The statement profile mode provides information about time spent in each statement.

Coverage

Code coverage.

Bytecode

The bytecode profile mode provides information about bytecode instructions.

BytecodePairs

The bytecode profile mode provides information about bytecode instruction pairs.

TimeFlame

Provide output compatible with flamegraph.pl.

Typecheck

Profile runtime typechecking.

None

Don’t record any profile information.

Implementations

impl ProfileMode

pub fn requires_frozen_module(&self) -> bool

Profile data for this mode can be obtained from FrozenModule::heap_profile.

Trait Implementations

impl Allocative for ProfileMode

fn visit<'allocative_a, 'allocative_b: 'allocative_a>( &self, visitor: &'allocative_a mut Visitor<'allocative_b>, )

impl Clone for ProfileMode

fn clone(&self) -> ProfileMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProfileMode

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

Formats the value using the given formatter.

impl Display for ProfileMode

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

Formats the value using the given formatter.

impl Dupe for ProfileMode

fn dupe(&self) -> Self

impl FromStr for ProfileMode

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ProfileMode

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 PartialEq for ProfileMode

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

impl StructuralPartialEq for ProfileMode