Struct tracing_modality::ModalityIngestHandle

pub struct ModalityIngestHandle { /* private fields */ }

A handle to control the spawned ingest thread.

Implementations

impl ModalityIngestHandle

pub fn finish(self)

Stop accepting new trace events, flush all existing events, and stop ingest thread.

This function must be called at the end of your main thread to give the ingest thread a chance to flush all queued trace events out to modality.

Panics

This function uses std::thread::JoinHandle::join which may panic on some platforms if a thread attempts to join itself or otherwise may create a deadlock with joining threads. This case should be incredibly unlikely, if not impossible, but can not be statically guarenteed.