Skip to main content

Environment

Struct Environment 

Source
#[non_exhaustive]
pub struct Environment { pub governor: Option<String>, pub turbo: Option<bool>, pub smt: Option<bool>, pub invariant_tsc: Option<bool>, pub clock_source: Option<String>, pub throttled: Option<bool>, pub isolated_cpus: Option<String>, pub aslr: Option<bool>, pub on_ac: Option<bool>, pub load: Option<Load>, pub virtualized: bool, pub warnings: Vec<Warning>, }
Expand description

The machine, as a benchmark sees it.

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.
§governor: Option<String>

The CPU frequency governor ("performance", "powersave", "schedutil"), or the Windows power plan’s name.

§turbo: Option<bool>

Turbo or boost is enabled.

§smt: Option<bool>

Simultaneous multithreading (hyper-threading) is active.

§invariant_tsc: Option<bool>

The time-stamp counter runs at a constant rate (x86 only).

§clock_source: Option<String>

The kernel’s clock source (Linux): "tsc", "hpet".

§throttled: Option<bool>

The CPU was throttled for heat or power: since boot on Linux (the kernel’s counters), right now on Windows.

§isolated_cpus: Option<String>

The CPUs kept away from the scheduler (Linux isolcpus, nohz_full), as the kernel lists them: "2-3".

§aslr: Option<bool>

Address-space randomisation is on: run-to-run layout noise.

§on_ac: Option<bool>

On mains power.

§load: Option<Load>

The load average, where the OS keeps one.

§virtualized: bool

Running in a virtual machine.

§warnings: Vec<Warning>

What makes results noisy, in the order of the variants.

Implementations§

Source§

impl Environment

Source

pub fn is_reproducible(&self) -> bool

No warning that makes results noisy.

Source

pub fn write_kv(&self, out: &mut impl Write) -> Result

One line of key=value pairs; values with spaces are quoted.

§Errors

Whatever out returns.

Source

pub fn write_json(&self, out: &mut impl Write) -> Result

One JSON object; unknown values are null.

§Errors

Whatever out returns.

Trait Implementations§

Source§

impl Clone for Environment

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 Environment

Source§

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

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

impl Display for Environment

Source§

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

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

impl PartialEq for Environment

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Environment

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.