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 “packing” feature, then FrameData has interior mutability with double storage:

• Unpacked data (UnpackedFrameData)
• Packed (compressed) data

One or both are always stored. This allows RAM-efficient storage and viewing of many frames of profiling data. Packing and unpacking is done lazily, on-demand.

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>

Number of bytes used by the packed data, if packed.

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

Number of bytes used when unpacked, if known.

pub fn bytes_of_ram_used(&self) -> usize

bytes currently used by the unpacked and packed data.

pub fn has_packed(&self) -> bool

Do we have a packed version stored internally?

pub fn has_unpacked(&self) -> bool

Do we have a unpacked version stored internally?

pub fn packing_info(&self) -> PackingInfo

Provides an overview of the frame’s packing status.

The function retrieves both the sizes of the unpacked and packed frames, as well as whether packed/unpacked versions of the frame exist internally. The goal of this function is to minimize the number of lock accesses by consolidating information retrieval into a single operation.

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

Return the unpacked data.

This will lazily unpack if needed (and only once).

Returns Err if failing to decode the packed data.

pub fn pack(&self)

Make the FrameData use up less memory. Idempotent.

pub fn write_into( &self, scope_collection: &ScopeCollection, send_all_scopes: bool, write: &mut impl Write, ) -> Result<()>

Writes one FrameData into a stream, prefixed by its length (u32 le).

pub fn read_next(read: &mut impl Read) -> Result<Option<Self>>

Read the next FrameData from a stream.

None is returned if the end of the stream is reached (EOF), or an end-of-stream sentinel of 0u32 is read.

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.