Struct ThreadScope

pub struct ThreadScope { /* private fields */ }

Additional metadata and state for a specific thread.

You can think of a ThreadScope as a handle a thread has on itself. Each ThreadScope is an interface to advanced theard API below.

Implementations

impl ThreadScope

pub fn activity<S: Into<String>>(&self, activity: S)

Report the current thread activity.

This information will become accessible from the introspection API. The main use case is to aid application end users monitor, debug, and understand complex software they use and operate but not implement.

pub fn idle(&self)

Clear any previously reported activity.

pub fn scoped_activity<S: Into<String>>( &self, activity: S, ) -> ThreadScopeActivityGuard

Report the given activity for the duration of a scope.

The scope is considered over once the returned ThreadScopeActivityGuard is dropped.

pub fn should_shutdown(&self) -> bool

Check if the thread was requested to shutdown.