NoteValue

Enum NoteValue 

Source
pub enum NoteValue {
    Int(i64),
    Uint(u64),
    Float(f64),
    Bool(bool),
    Text(String),
}
Expand description

Result of checking a scenario run.

Contains pass/fail status, human-readable detail messages, and aggregated statistics. Multiple results can be combined with merge().

let mut a = AssertResult::pass();
assert!(a.is_pass());

let mut b = AssertResult::pass();
b.record_fail(AssertDetail::new(DetailKind::Starved, "worker starved"));

a.merge(b);
assert!(a.is_fail());
assert!(a.failure_details().any(|d| d.kind == DetailKind::Starved));

Structured measurement value attached via AssertResult::note_value / Verdict::note_value.

The variants cover every primitive shape stats tooling consumes: signed and unsigned 64-bit ints, 64-bit floats, booleans, and owned strings. A test that wants to surface “max_wchar=12345” alongside a passing IO_ACCOUNTING reachability check writes verdict.note_value("max_wchar", 12345i64) and downstream stats tooling reads result.measurements["max_wchar"] as NoteValue::Int(12345).

Distinct from AssertResult::info_notes’s free-form InfoNote messages: an InfoNote carries a single human- readable string (formatted via its Display impl), the structured map carries typed (key, NoteValue) pairs for programmatic consumption (sidecar parsers, perf-delta, regression dashboards). Producers can call BOTH note(msg) and note_value(key, val) on the same result — they occupy independent buffers (info_notes vs measurements).

Conversion via the From impls below: any i64/u64/f64/bool/String/&str literal flows into note_value without explicit variant naming. Integer types narrower than 64-bit (i32, u32, etc.) need an explicit cast at the call site rather than a blanket impl, so the call site reads honestly about the value’s resolution.

Derives PartialEq but NOT Eq: the Float(f64) variant holds IEEE-754 doubles where NaN != NaN, which violates the reflexivity requirement on Eq. Equality on NoteValue is partial-equivalence semantics for the same reason f64 is.

Uses serde’s externally-tagged default (no #[serde(untagged)]). Like Outcome, NoteValue is wire-encoded as part of AssertResult::measurements via postcard’s TLV transport from guest to host. Postcard is not a self-describing format and cannot decode #[serde(untagged)] enums (returns WontImplement) — pre-fix the decode silently failed when any test populated measurements before its result crossed the wire. The externally-tagged default (JSON form {"Int": 42} / {"Text": "x"}) is what postcard’s externally-tagged enum decoder expects. The assert_result_postcard_roundtrip test pins this contract so a regression that re-adds #[serde(untagged)] trips at test time rather than as a silent data drop at runtime.

Variants§

§

Int(i64)

64-bit signed integer — pid_t, exit codes, signed counters.

§

Uint(u64)

64-bit unsigned integer — work_units, byte counts, durations.

§

Float(f64)

64-bit float — ratios, rates, percentiles in microseconds.

§

Bool(bool)

Boolean — completion flags, feature-detect results.

§

Text(String)

Owned string — categorical labels, environment tokens.

Trait Implementations§

Source§

impl Clone for NoteValue

Source§

fn clone(&self) -> NoteValue

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NoteValue

Source§

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

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

impl<'de> Deserialize<'de> for NoteValue

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 From<&str> for NoteValue

Source§

fn from(v: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for NoteValue

Source§

fn from(v: String) -> Self

Converts to this type from the input type.
Source§

impl From<bool> for NoteValue

Source§

fn from(v: bool) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for NoteValue

Source§

fn from(v: f64) -> Self

Converts to this type from the input type.
Source§

impl From<i64> for NoteValue

Source§

fn from(v: i64) -> Self

Converts to this type from the input type.
Source§

impl From<u64> for NoteValue

Source§

fn from(v: u64) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for NoteValue

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for NoteValue

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
Source§

impl StructuralPartialEq for NoteValue

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,