Struct Record 

pub struct Record<'a> { /* private fields */ }

A view into a Sampler’s ring buffer for a single kernel event record.

When dropped, this type will advance the tail pointer in the ringbuffer of the Sampler that it references. To avoid this, you can use std::mem::forget so the next call to Sampler::next_record will return the same record again.

Implementations

impl<'s> Record<'s>

pub fn ty(&self) -> u32

Access the type field of the kernel record header.

This indicates the type of the record emitted by the kernel.

pub fn misc(&self) -> u16

Access the misc field of the kernel record header.

This contains a set of flags that carry some additional metadata on the record being emitted by the kernel.

pub fn len(&self) -> usize

Get the total length, in bytes, of this record.

pub fn data(&self) -> &[&[u8]]

Access the bytes of this record.

Since the underlying buffer is a ring buffer the bytes of the record may end up wrapping around the end of the buffer. That gets exposed here as data returning either one or two byte slices. If there is no wrap-around then one slice will be returned here, otherwise, two will be returned.

pub fn to_vec(&self) -> Vec<u8>

Copy the bytes of this record to an owned Vec.

pub fn to_contiguous(&self) -> Cow<'_, [u8]>

Get the bytes of this record as a single contiguous slice.

For most records this is effectively free but if the record wraps around the end of the ringbuffer then it will be copied to a vector.

pub fn parse_record(&self) -> ParseResult<Record<'_>>

Parse the data in this record to a data::Record enum.

Trait Implementations

impl<'s> Drop for Record<'s>

fn drop(&mut self)

Executes the destructor for this type.

impl<'s> Send for Record<'s>

impl<'s> Sync for Record<'s>