Skip to main content

BenchmarkReceipt

Struct BenchmarkReceipt 

Source
pub struct BenchmarkReceipt {
    pub timestamp: DateTime<Utc>,
    pub commit_hash: String,
    pub machine_fingerprint: String,
    pub results: Vec<BenchmarkResult>,
    pub note: Option<String>,
}
Expand description

A benchmark receipt captures the results and context of a single benchmark run.

Receipts are keyed to:

  • A commit hash (git SHA)
  • A machine fingerprint
  • A timestamp (UTC)

This enables reproducible diffs between runs across different machines.

Fields§

§timestamp: DateTime<Utc>

Timestamp of the benchmark run (UTC)

§commit_hash: String

Git commit SHA of the code being benchmarked

§machine_fingerprint: String

Machine fingerprint (hostname + username + arch + OS + cpu count + machine-id)

§results: Vec<BenchmarkResult>

Benchmark results indexed by name

§note: Option<String>

Optional note about the run environment

Implementations§

Source§

impl BenchmarkReceipt

Source

pub fn new(commit_hash: String, machine_fingerprint: String) -> Self

Create a new receipt with the current timestamp.

Source

pub fn with_fingerprint( commit_hash: String, fingerprint: &MachineFingerprint, ) -> Self

Create a new receipt from a fingerprint struct.

Source

pub fn add_result(&mut self, result: BenchmarkResult)

Add a benchmark result to this receipt.

Source

pub fn receipt_hash(&self) -> String

Compute a short hash of this receipt for quick comparison.

Uses only the commit hash, machine fingerprint, and result names/values. Timestamp is excluded to allow comparing logically equivalent runs.

Source

pub fn set_note(&mut self, note: impl Into<String>)

Set an optional note about this run.

Source

pub fn to_json(&self) -> Result<Vec<u8>, QuantEvalError>

Serialize this receipt to JSON bytes.

Source

pub fn from_json(bytes: &[u8]) -> Result<Self, QuantEvalError>

Deserialize a receipt from JSON bytes.

Trait Implementations§

Source§

impl Clone for BenchmarkReceipt

Source§

fn clone(&self) -> BenchmarkReceipt

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 BenchmarkReceipt

Source§

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

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

impl<'de> Deserialize<'de> for BenchmarkReceipt

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for BenchmarkReceipt

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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 = 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.