Struct TraceTask

pub struct TraceTask { /* private fields */ }

Implementations

impl TraceTask

pub async fn new( debug_tag: String, config: TraceConfig, duration: Option<Duration>, triggers: Vec<Trigger>, requested_categories: Option<Vec<String>>, provisioner: ProvisionerProxy, ) -> Result<Self, TracingError>

pub fn triggers(&self) -> Vec<Trigger>

pub fn config(&self) -> TraceConfig

pub fn start_time(&self) -> Instant

pub fn duration(&self) -> Option<Duration>

pub fn requested_categories(&self) -> Vec<String>

pub fn task_id(&self) -> u64

pub async fn stop_and_receive_data<W>( self, writer: W, ) -> Result<StopResult, TracingError>

where W: AsyncWrite + Unpin + Send + 'static,

Signals the trace session to stop, copies all trace data to the provided writer, and awaits task completion.

pub async fn await_completion_and_receive_data<W>( self, writer: W, ) -> Result<StopResult, TracingError>

where W: AsyncWrite + Unpin + Send + 'static,

Waits for the tracing task to complete and copies the trace data to the writer. If the tracing should be stopped vs. waiting, call |stop_and_receive_data|.

Trait Implementations

impl Debug for TraceTask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Future for TraceTask

type Output = Option<StopResult>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut FutContext<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.