Struct exec_duration::ExecProbe

pub struct ExecProbe { /* fields omitted */ }

Execution probe structure. Instances are created using ExecProbe::new function.

Examples

use exec_duration;
use exec_duration::ExecProbe;

let mut ep = ExecProbe::new("function_1");

Implementations

impl ExecProbe

pub fn new(name: &str) -> Self

Create a new instance

Examples

use exec_duration;
use exec_duration::ExecProbe;

let ep = ExecProbe::new("main");

pub fn add_point(&mut self, name: &str)

Add a new point

Examples

use exec_duration;
use exec_duration::ExecProbe;

let mut ep = ExecProbe::new("main");
ep.add_point("line 1");

pub fn stop(&mut self)

Stop metrics and commit

In most cases a call to this function is optional because ExecProbe implements the Drop trait and when an ExecProbe instance goes out of scope, a call to stop function will be performed automatically.

Examples

use exec_duration;
use exec_duration::ExecProbe;

let mut ep = ExecProbe::new("main");
ep.add_point("line 1");
ep.stop();

Trait Implementations

impl Clone for ExecProbe

fn clone(&self) -> ExecProbe

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecProbe

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

Formats the value using the given formatter.

impl Drop for ExecProbe

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for ExecProbe

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ExecProbe

fn cmp(&self, other: &ExecProbe) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ExecProbe> for ExecProbe

fn eq(&self, other: &ExecProbe) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ExecProbe) -> bool

This method tests for !=.

impl PartialOrd<ExecProbe> for ExecProbe

fn partial_cmp(&self, other: &ExecProbe) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ExecProbe

impl StructuralEq for ExecProbe

impl StructuralPartialEq for ExecProbe