Struct rstack_self::TraceOptions

pub struct TraceOptions { /* fields omitted */ }

Options controlling tracing.

Methods

impl TraceOptions

pub fn new() -> TraceOptions

Returns a new TraceOptions with default settings.

pub fn snapshot(&mut self, snapshot: bool) -> &mut TraceOptions

If set, the threads of the process will be traced in a consistent snapshot.

A snapshot-mode trace ensures a consistent view of all threads, but requires that all threads be paused for the entire duration of the trace.

Defaults to false.

pub fn trace(&self, child: &mut Command) -> Result<Trace>

Returns stack traces of all of the threads in the calling process.

The provided Command should be configured to spawn a process which will call the child function. It must not use standard input or standard output, but standard error will be inherited and can be used. The spawned process must "directly" call child rather than spawning another process to call it. That is, the parent of the process that calls child is the one that will be traced.

Trait Implementations

impl Default for TraceOptions

fn default() -> TraceOptions

Returns the "default value" for a type.

impl Clone for TraceOptions

fn clone(&self) -> TraceOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TraceOptions

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

Formats the value using the given formatter.