Struct puffin::FrameData

pub struct FrameData { /* 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.

Implementations

impl FrameData

pub fn new(
    frame_index: FrameIndex,
    thread_streams: BTreeMap<ThreadInfo, StreamInfo>
) -> Result<Self>

pub fn meta(&self) -> &FrameMeta

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 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, 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

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

pub fn duration_ns(&self) -> NanoSecond