ParamValues

Struct ParamValues 

Source
pub struct ParamValues(/* private fields */);
Expand description

2026-09-26: The edited values handed to Benchmark::configure.

Accessors return Err on a missing or mistyped key rather than falling back to a default: a benchmark that reads a key its schema never declared is a bug, and a substituted value would hide it behind a plausible number. float also accepts an Int.

Implementations§

Source§

impl ParamValues

Source

pub fn iter(&self) -> impl Iterator<Item = (&str, &ParamValue)>

2026-09-26: Every (key, value) pair, in key order (the map is a BTreeMap), so records built from the same values diff cleanly.

Source

pub fn to_strings(&self) -> BTreeMap<String, String>

2026-09-26: The whole configuration as text, for persistence.

Source

pub fn from_overrides<'a>( specs: &[ParamSpec], overrides: impl IntoIterator<Item = (&'a str, &'a str)>, ) -> Result<Self>

2026-09-26: Schema defaults with overrides applied on top.

Every value is routed through ParamKind::parse, so an out-of-domain override fails here rather than mid-run. An unknown key is an error naming the valid ones: an ignored --param typo would measure something other than what was asked for.

Source§

impl ParamValues

Source

pub fn defaults(specs: &[ParamSpec]) -> Self

2026-09-26: Starting values for a schema: each spec’s default.

Source

pub fn set(&mut self, key: impl Into<String>, value: ParamValue)

Source

pub fn get(&self, key: &str) -> Option<&ParamValue>

Source

pub fn bool(&self, key: &str) -> Result<bool>

Source

pub fn int(&self, key: &str) -> Result<i64>

Source

pub fn usize(&self, key: &str) -> Result<usize>

2026-09-26: int, refused when negative.

Source

pub fn float(&self, key: &str) -> Result<f64>

Source

pub fn text(&self, key: &str) -> Result<&str>

Source

pub fn int_list(&self, key: &str) -> Result<&[i64]>

Source

pub fn validate_against(&self, specs: &[ParamSpec]) -> Result<()>

2026-09-26: Refuse an unknown key, a missing key, or a value that does not parse-check against its spec. Headless runs call it before a run, and every driver’s configure except vision’s and video’s calls it first, so a bad field is reported against the field rather than as a mid-run failure.

Trait Implementations§

Source§

impl Clone for ParamValues

Source§

fn clone(&self) -> ParamValues

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 ParamValues

Source§

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

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

impl Default for ParamValues

Source§

fn default() -> ParamValues

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ParamValues

Source§

fn eq(&self, other: &ParamValues) -> 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 StructuralPartialEq for ParamValues

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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

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> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
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<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