Task

Struct Task 

Source
pub struct Task<'a>(/* private fields */);
Expand description

A task is a logical unit of work performed by a particular thread. See the Task API documentation for more information.

let _env_path = scoped_env::ScopedEnv::set("INTEL_LIBITTNOTIFY64", "<some path>");
let domain = Domain::new("domain");
let name = StringHandle::new("task");
// Measure a task using a pre-initialized string handle (most efficient).
{
    let task = Task::begin(&domain, name);
    let _ = 2 + 2;
    task.end(); // Task ended here.
    let _ = 3 + 3;
}
// Measure a task using a string reference (most convenient).
{
    let _task = Task::begin(&domain, "task");
    let _ = 2 + 2;
    // Task ended here, when dropped.
}

Implementations§

Source§

impl<'a> Task<'a>

Source

pub fn begin(domain: &'a Domain, name: impl Into<StringHandle>) -> Self

Start a task on the current thread.

Source

pub fn end(self)

Finish the task.

Trait Implementations§

Source§

impl<'a> Drop for Task<'a>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Task<'a>

§

impl<'a> RefUnwindSafe for Task<'a>

§

impl<'a> Send for Task<'a>

§

impl<'a> Sync for Task<'a>

§

impl<'a> Unpin for Task<'a>

§

impl<'a> UnwindSafe for Task<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.