Struct xi_trace::Sample

pub struct Sample {
    pub name: StrCow,
    pub categories: Option<CategoriesT>,
    pub timestamp_us: u64,
    pub event_type: SampleEventType,
    pub duration_us: Option<u64>,
    pub pid: u64,
    pub tid: u64,
    pub thread_name: Option<StrCow>,
    pub args: Option<SampleArgs>,
}

Stores the relevant data about a sample for later serialization. The payload associated with any sample is by default a string but may be configured via the json_payload feature (there is an associated performance hit across the board for turning it on).

Fields

name: StrCow

The name of the event to be shown.

categories: Option<CategoriesT>

List of categories the event applies to.

timestamp_us: u64

When was the sample started.

event_type: SampleEventType

What kind of sample this is.

duration_us: Option<u64>

pid: u64

The process the sample was captured in.

tid: u64

The thread the sample was captured on. Omitted for Metadata events that want to set the process name (if provided then sets the thread name).

thread_name: Option<StrCow>

args: Option<SampleArgs>

Methods

impl Sample

pub fn new_duration_marker<S, C>(
    name: S,
    categories: C,
    payload: Option<TracePayloadT>,
    event_type: SampleEventType
) -> Self where
    S: Into<StrCow>,
    C: Into<CategoriesT>, 

Constructs a Begin or End sample. Should not be used directly. Instead should be constructed via SampleGuard.

pub fn new_duration<S, C>(
    name: S,
    categories: C,
    payload: Option<TracePayloadT>,
    start_ns: u64,
    duration_ns: u64
) -> Self where
    S: Into<StrCow>,
    C: Into<CategoriesT>, 

Constructs a Duration sample. For use via xi_trace::closure.

pub fn new_instant<S, C>(
    name: S,
    categories: C,
    payload: Option<TracePayloadT>
) -> Self where
    S: Into<StrCow>,
    C: Into<CategoriesT>, 

Constructs an instantaneous sample.

Trait Implementations

impl PartialOrd<Sample> for Sample

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl Eq for Sample

impl PartialEq<Sample> for Sample

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Ord for Sample

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Clone for Sample

fn clone(&self) -> Sample

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for Sample

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 Debug for Sample

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

Formats the value using the given formatter.

impl Serialize for Sample

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Sample

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.