Struct perfcnt::linux::perf_format::SampleFormatFlags

pub struct SampleFormatFlags { /* fields omitted */ }

Implementations

impl SampleFormatFlags

pub const PERF_SAMPLE_IP: SampleFormatFlags

Records instruction pointer.

pub const PERF_SAMPLE_TID: SampleFormatFlags

Records the process and thread IDs.

pub const PERF_SAMPLE_TIME: SampleFormatFlags

Records a timestamp.

pub const PERF_SAMPLE_ADDR: SampleFormatFlags

Records an address, if applicable.

pub const PERF_SAMPLE_READ: SampleFormatFlags

Record counter values for all events in a group, not just the group leader.

pub const PERF_SAMPLE_CALLCHAIN: SampleFormatFlags

Records the callchain (stack backtrace).

pub const PERF_SAMPLE_ID: SampleFormatFlags

Records a unique ID for the opened event's group leader.

pub const PERF_SAMPLE_CPU: SampleFormatFlags

Records CPU number.

pub const PERF_SAMPLE_PERIOD: SampleFormatFlags

Records the current sampling period.

pub const PERF_SAMPLE_STREAM_ID: SampleFormatFlags

Records a unique ID for the opened event. Unlike PERF_SAMPLE_ID the actual ID is returned, not the group leader. This ID is the same as the one returned by PERF_FORMAT_ID.

pub const PERF_SAMPLE_RAW: SampleFormatFlags

Records additional data, if applicable. Usually returned by tracepoint events.

pub const PERF_SAMPLE_BRANCH_STACK: SampleFormatFlags

This provides a record of recent branches, as provided by CPU branch sampling hardware (such as Intel Last Branch Record). Not all hardware supports this feature. See the branch_sample_type field for how to filter which branches are reported.

pub const PERF_SAMPLE_REGS_USER: SampleFormatFlags

Records the current user-level CPU register state (the values in the process before the kernel was called).

pub const PERF_SAMPLE_STACK_USER: SampleFormatFlags

Records the user level stack, allowing stack unwinding.

pub const PERF_SAMPLE_WEIGHT: SampleFormatFlags

Records a hardware provided weight value that expresses how costly the sampled event was. This allows the hardware to highlight expensive events in a profile.

pub const PERF_SAMPLE_DATA_SRC: SampleFormatFlags

Records the data source: where in the memory hierarchy the data associated with the sampled instruction came from. This is only available if the underlying hardware supports this feature.

pub const PERF_SAMPLE_IDENTIFIER: SampleFormatFlags

pub const PERF_SAMPLE_TRANSACTION: SampleFormatFlags

pub const PERF_SAMPLE_REGS_INTR: SampleFormatFlags

pub const fn empty() -> SampleFormatFlags

Returns an empty set of flags

pub const fn all() -> SampleFormatFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u64) -> Option<SampleFormatFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u64) -> SampleFormatFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u64) -> SampleFormatFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: SampleFormatFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: SampleFormatFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: SampleFormatFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: SampleFormatFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: SampleFormatFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: SampleFormatFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl SampleFormatFlags

pub fn has_ip(&self) -> bool

pub fn has_tid(&self) -> bool

pub fn has_time(&self) -> bool

pub fn has_addr(&self) -> bool

pub fn has_read(&self) -> bool

pub fn has_callchain(&self) -> bool

pub fn has_sample_id(&self) -> bool

pub fn has_cpu(&self) -> bool

pub fn has_period(&self) -> bool

pub fn has_stream_id(&self) -> bool

pub fn has_raw(&self) -> bool

pub fn has_branch_stack(&self) -> bool

pub fn has_regs_user(&self) -> bool

pub fn has_stack_user(&self) -> bool

pub fn has_weight(&self) -> bool

pub fn has_data_src(&self) -> bool

pub fn has_identifier(&self) -> bool

pub fn has_transaction(&self) -> bool

pub fn has_regs_intr(&self) -> bool

Trait Implementations

impl Binary for SampleFormatFlags

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

Formats the value using the given formatter.

impl BitAnd<SampleFormatFlags> for SampleFormatFlags

type Output = SampleFormatFlags

The resulting type after applying the & operator.

fn bitand(self, other: SampleFormatFlags) -> SampleFormatFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<SampleFormatFlags> for SampleFormatFlags

fn bitand_assign(&mut self, other: SampleFormatFlags)

Disables all flags disabled in the set.

impl BitOr<SampleFormatFlags> for SampleFormatFlags

type Output = SampleFormatFlags

The resulting type after applying the | operator.

fn bitor(self, other: SampleFormatFlags) -> SampleFormatFlags

Returns the union of the two sets of flags.

impl BitOrAssign<SampleFormatFlags> for SampleFormatFlags

fn bitor_assign(&mut self, other: SampleFormatFlags)

Adds the set of flags.

impl BitXor<SampleFormatFlags> for SampleFormatFlags

type Output = SampleFormatFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: SampleFormatFlags) -> SampleFormatFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<SampleFormatFlags> for SampleFormatFlags

fn bitxor_assign(&mut self, other: SampleFormatFlags)

Toggles the set of flags.

impl Clone for SampleFormatFlags

fn clone(&self) -> SampleFormatFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SampleFormatFlags

impl Debug for SampleFormatFlags

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

Formats the value using the given formatter.

impl Eq for SampleFormatFlags

impl Extend<SampleFormatFlags> for SampleFormatFlags

fn extend<T: IntoIterator<Item = SampleFormatFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<SampleFormatFlags> for SampleFormatFlags

fn from_iter<T: IntoIterator<Item = SampleFormatFlags>>(
    iterator: T
) -> SampleFormatFlags

Creates a value from an iterator.

impl Hash for SampleFormatFlags

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for SampleFormatFlags

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

Formats the value using the given formatter.

impl Not for SampleFormatFlags

type Output = SampleFormatFlags

The resulting type after applying the ! operator.

fn not(self) -> SampleFormatFlags

Returns the complement of this set of flags.

impl Octal for SampleFormatFlags

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

Formats the value using the given formatter.

impl Ord for SampleFormatFlags

fn cmp(&self, other: &SampleFormatFlags) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<SampleFormatFlags> for SampleFormatFlags

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

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

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

This method tests for !=.

impl PartialOrd<SampleFormatFlags> for SampleFormatFlags

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for SampleFormatFlags

impl StructuralPartialEq for SampleFormatFlags

impl Sub<SampleFormatFlags> for SampleFormatFlags

type Output = SampleFormatFlags

The resulting type after applying the - operator.

fn sub(self, other: SampleFormatFlags) -> SampleFormatFlags

Returns the set difference of the two sets of flags.

impl SubAssign<SampleFormatFlags> for SampleFormatFlags

fn sub_assign(&mut self, other: SampleFormatFlags)

Disables all flags enabled in the set.

impl UpperHex for SampleFormatFlags

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

Formats the value using the given formatter.