Skip to main content

Options

Struct Options 

Source
#[non_exhaustive]
pub struct Options { pub stop_gap_target: Duration, pub report_gap_target: Duration, pub callback_budget: Duration, pub callback_interval_target: Duration, pub check_calls_per_second: f64, pub report_calls_per_second: f64, pub minimum_calls: u64, pub minimum_stage_wall: Duration, pub weight_difference: f64, pub negligible_stage_share: f64, pub uneven_pace_ratio: f64, }
Expand description

Thresholds for Trace::diagnose. Start from Default and adjust fields.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§stop_gap_target: Duration

Longest acceptable stretch without a cancellation check. Default 10 ms.

§report_gap_target: Duration

Longest acceptable stretch without a report. Default 50 ms.

§callback_budget: Duration

Longest acceptable callback. Default 10 ms.

§callback_interval_target: Duration

Longest acceptable time between two runs of one callback. Default 10 ms.

§check_calls_per_second: f64

Check rate above which a busy call site gets a frequency note.

§report_calls_per_second: f64

Report rate above which a busy call site gets a batching note.

§minimum_calls: u64

Calls a site must make before it gets a frequency note.

§minimum_stage_wall: Duration

Sequential stages must run at least this long in total before their weights are compared with measured time.

§weight_difference: f64

Smallest difference between a stage’s declared and measured share that produces weight advice.

§negligible_stage_share: f64

A stage that took less than this share of the sequence’s time is too small to calibrate from one run (a flush that is trivial for this input may not be for the next). It keeps its declared weight, as long as the stages held this way together own at most half the bar.

§uneven_pace_ratio: f64

A task whose slowest quarter of reported units took at least this many times as long as its fastest gets Kind::UnevenPace advice. It needs report timing, at least 8 reports, and minimum_stage_wall of wall time. A fastest quarter under the clock’s resolution counts as zero, so any slower quarter qualifies. Default 4.

Trait Implementations§

Source§

impl Clone for Options

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Options

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Options

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.