Struct puffin::FrameData

pub struct FrameData {
    pub scope_delta: Vec<Arc<ScopeDetails>>,
    pub full_delta: bool,
    /* private fields */
}

One frame worth of profile data, collected from many sources.

If you turn on the the “packing” feature, this will compress the profiling data in order to save RAM.

Fields

scope_delta: Vec<Arc<ScopeDetails>>

Scopes that were registered during this frame.

full_delta: bool

Does Self::scope_delta contain all the scopes up to this point? If false, it just contains the new scopes since last frame data.

Implementations

impl FrameData

pub fn new( frame_index: FrameIndex, thread_streams: BTreeMap<ThreadInfo, StreamInfo>, scope_delta: Vec<Arc<ScopeDetails>>, full_delta: bool ) -> Result<Self>

Create a new FrameData.

pub fn meta(&self) -> &FrameMeta

Returns meta data from this frame.

pub fn packed_size(&self) -> Option<usize>

Always returns None.

pub fn unpacked_size(&self) -> Option<usize>

Number of bytes used when unpacked.

pub fn bytes_of_ram_used(&self) -> usize

Bytes currently used by the unpacked data.

pub fn has_packed(&self) -> bool

Always returns false.

pub fn has_unpacked(&self) -> bool

Always returns true.

pub fn unpacked(&self) -> Result<Arc<UnpackedFrameData>, Never>

Return the unpacked data.

pub fn pack(&self)

Does nothing because this FrameData is unpacked by default.

impl FrameData

pub fn frame_index(&self) -> u64

The index of this frame.

pub fn range_ns(&self) -> (NanoSecond, NanoSecond)

The range in nanoseconds of the entire profile frame.

pub fn duration_ns(&self) -> NanoSecond

The duration in nanoseconds of the entire profile frame.