Struct RunReceipt 

pub struct RunReceipt {
    pub schema: String,
    pub tool: ToolInfo,
    pub run: RunMeta,
    pub bench: BenchMeta,
    pub samples: Vec<Sample>,
    pub stats: Stats,
}

A versioned receipt from a single benchmark run (perfgate.run.v1).

Examples

use perfgate_types::*;

let receipt = RunReceipt {
    schema: RUN_SCHEMA_V1.to_string(),
    tool: ToolInfo { name: "perfgate".into(), version: "0.1.0".into() },
    run: RunMeta {
        id: "run-1".into(),
        started_at: "2024-01-01T00:00:00Z".into(),
        ended_at: "2024-01-01T00:00:01Z".into(),
        host: HostInfo {
            os: "linux".into(), arch: "x86_64".into(),
            cpu_count: None, memory_bytes: None, hostname_hash: None,
        },
    },
    bench: BenchMeta {
        name: "my-bench".into(), cwd: None,
        command: vec!["echo".into(), "hello".into()],
        repeat: 3, warmup: 0, work_units: None, timeout_ms: None,
    },
    samples: vec![],
    stats: Stats {
        wall_ms: U64Summary::new(100, 90, 120 ),
        cpu_ms: None, page_faults: None, ctx_switches: None,
        max_rss_kb: None, io_read_bytes: None, io_write_bytes: None,
        network_packets: None, energy_uj: None, binary_bytes: None, throughput_per_s: None,
    },
};

// Serialize to JSON
let json = serde_json::to_string(&receipt).unwrap();
assert!(json.contains("perfgate.run.v1"));

Fields

schema: String

tool: ToolInfo

run: RunMeta

bench: BenchMeta

samples: Vec<Sample>

stats: Stats

Trait Implementations

impl Clone for RunReceipt

fn clone(&self) -> RunReceipt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunReceipt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RunReceipt

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RunReceipt

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for RunReceipt

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RunReceipt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RunReceipt