Enum BenchInit

Source
pub enum BenchInit {
    Disabled,
    Enabled(BenchSession),
}
Expand description

Result of environment-driven benchmark initialization.

§Examples

use ailloli_ui_bench::BenchInit;
let init = BenchInit::Disabled;
assert!(init.path().is_none());

Variants§

§

Disabled

Benchmark collection was not requested.

§

Enabled(BenchSession)

Benchmark collection is active. Keep the session alive for the whole run.

Implementations§

Source§

impl BenchInit

Source

pub fn finish(self) -> Result<Option<CompletedRun>, BenchWriteError>

Finishes an enabled session. Disabled collection returns Ok(None).

§Errors

Propagates writer, flush, sync, validity, and publication failures from an enabled session.

§Examples
use ailloli_ui_bench::BenchInit;
assert_eq!(BenchInit::Disabled.finish()?, None);
Source

pub fn path(&self) -> Option<&Path>

Returns the final output path when collection is enabled.

§Examples
use ailloli_ui_bench::BenchInit;
assert!(BenchInit::Disabled.path().is_none());
Source

pub fn session(&self) -> Option<&BenchSession>

Borrows the active session when collection is enabled.

§Examples
use ailloli_ui_bench::BenchInit;
assert!(BenchInit::Disabled.session().is_none());

Trait Implementations§

Source§

impl Debug for BenchInit

Source§

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

Formats the value using the given formatter. 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> 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> Same for T

Source§

type Output = T

Should always be Self
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.