Struct OSActivity 

pub struct OSActivity { /* private fields */ }

Safe wrapper around os_activity_t.

Implementations

impl OSActivity

pub fn new( description: &str, parent: Option<&OSActivity>, flags: OSActivityFlags, ) -> Result<Self, LogError>

Creates a new activity.

Pass None to use OS_ACTIVITY_CURRENT, or Some(&OSActivity::null()) to pass the explicit OS_ACTIVITY_NULL sentinel.

Errors

Returns an error if the description contains a NUL byte or the bridge fails.

pub fn start( description: &str, flags: OSActivityFlags, ) -> Result<Self, LogError>

Creates a deprecated started activity.

Errors

Returns an error if the description contains a NUL byte or the bridge fails.

pub fn initiate<F>( description: &str, flags: OSActivityFlags, closure: F, ) -> Result<(), LogError>

where F: FnOnce(),

Synchronously initiates an activity around a closure.

Errors

Returns an error if the description contains a NUL byte.

pub fn initiate_f<C, F>( description: &str, flags: OSActivityFlags, context: &mut C, function: F, ) -> Result<(), LogError>

where F: FnOnce(&mut C),

Synchronously initiates an activity and passes a mutable context value to the callback.

Errors

Returns an error if the description contains a NUL byte.

pub fn current() -> Self

pub fn none() -> Self

pub fn null() -> Self

pub fn identifiers(&self) -> ActivityIds

pub fn identifier(&self) -> u64

pub fn apply<F>(&self, closure: F)

where F: FnOnce(),

pub const fn instrument_future<F>(self, future: F) -> ActivityFuture<F>

where F: Future,

Available on crate feature async only.

Wrap a future so this activity is entered around every poll.

pub fn enter(&self) -> Result<OSActivityScope, LogError>

Enters the activity for the current scope.

Errors

Returns an error if the bridge cannot allocate scope state.

pub fn end(&self)

pub fn label_user_action(label: &str)

pub fn set_breadcrumb(name: &str)

Trait Implementations

impl Drop for OSActivity

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.