JsonField

Enum JsonField 

Source
#[non_exhaustive]
pub enum JsonField<'a> { Value(&'a Value), Missing(SnapshotError), }
Expand description

One value’s view at the leaf of a dotted-path walk over a serde_json::Value. Returned by stats_path / StatsValue::get.

Mirrors the super::SnapshotField shape so test authors who already know the BPF-snapshot accessor surface get the same as_u64 / as_i64 / as_f64 / as_bool / as_str terminals on the scx_stats JSON projection. Errors flow through the same SnapshotError variants — FieldNotFound carries the available object keys, NotAStruct flags a non-object cursor, TypeMismatch reports the actual JSON shape — so failure-path rendering in temporal assertions is identical regardless of which side of the Sample bundle the lookup originated on.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Value(&'a Value)

Resolved JSON value at the leaf of the path walk.

§

Missing(SnapshotError)

Path could not be resolved.

Implementations§

Source§

impl<'a> JsonField<'a>

Source

pub fn is_present(&self) -> bool

True when the path resolved.

Source

pub fn raw(&self) -> Option<&'a Value>

Underlying JSON value if present.

Source

pub fn error(&self) -> Option<&SnapshotError>

Error reference when the path could not be resolved.

Source

pub fn get(&self, path: &str) -> JsonField<'a>

Walk further into a sub-field. Composable with the result of stats_pathstats_path(v, "layers").get("batch.util") is the canonical “drill into a periodic-stats object” shape. Mirrors super::SnapshotField::get so a test author moves between the BTF-rendered and JSON-rendered surfaces without re-learning the navigator method name.

Source

pub fn as_u64(&self) -> SnapshotResult<u64>

Read as u64. Accepts JSON integers (positive only), JSON booleans (true → 1, false → 0), JSON strings whose content parses as a u64 (scx_stats sometimes stringifies large counters to avoid 53-bit float collapse), and JSON floats that are integral and non-negative (5.0 → 5; fractional, negative, or non-finite floats error). Returns SnapshotError::TypeMismatch otherwise.

Source

pub fn as_i64(&self) -> SnapshotResult<i64>

Read as i64. Accepts JSON integers (any sign), JSON booleans (true → 1, false → 0), JSON strings whose content parses as an i64, and integral finite JSON floats (9.0 → 9; fractional or non-finite floats error).

Source

pub fn as_f64(&self) -> SnapshotResult<f64>

Read as f64. Accepts JSON numbers (integers and floating-point) and JSON strings whose content parses as f64.

Source

pub fn as_bool(&self) -> SnapshotResult<bool>

Read as bool. Accepts JSON booleans directly; rejects everything else. Distinct from as_u64() != 0 so the call site reads honestly: a bool claim wants a JSON true/ false, not a stringified "1" that happens to parse.

Source

pub fn as_str(&self) -> SnapshotResult<&'a str>

Read as &str. Accepts JSON strings only.

Source

pub fn as_u64_array(&self) -> SnapshotResult<Vec<u64>>

Read as Vec<u64> from a serde_json::Value::Array whose every element coerces via Self::as_u64’s rules. Mirrors super::SnapshotField::as_u64_array so JSON-side stats reads use the same method name as BTF-side BPF reads.

Source

pub fn as_u32_array(&self) -> SnapshotResult<Vec<u32>>

Read as Vec<u32> from a JSON array. Mirrors super::SnapshotField::as_u32_array; out-of-range values error rather than silently truncate.

Source

pub fn as_i64_array(&self) -> SnapshotResult<Vec<i64>>

Read as Vec<i64> from a JSON array. Mirrors super::SnapshotField::as_i64_array.

Source

pub fn as_f64_array(&self) -> SnapshotResult<Vec<f64>>

Read as Vec<f64> from a JSON array. Mirrors super::SnapshotField::as_f64_array.

Source

pub fn as_bool_array(&self) -> SnapshotResult<Vec<bool>>

Read as Vec<bool> from a JSON array of booleans. Mirrors super::SnapshotField::as_bool_array; rejects mixed arrays (no implicit truthiness coercion — JSON-side bool already has a wire shape).

Source

pub fn iter_members(&self) -> impl Iterator<Item = JsonField<'a>> + '_

Iterate the elements of a JSON array as JsonFields so chained navigation composes for arrays-of-objects: field.iter_members().filter_map(|el| el.get("name").as_u64().ok()). Mirrors super::SnapshotField::iter_members.

Yields nothing for non-array values or missing fields — the empty iterator is the natural “no elements” shape when the chain just wants to fold over what’s there. Callers needing to distinguish “absent” from “empty” check Self::is_present or Self::error explicitly.

Trait Implementations§

Source§

impl<'a> Clone for JsonField<'a>

Source§

fn clone(&self) -> JsonField<'a>

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<'a> Debug for JsonField<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for JsonField<'a>

§

impl<'a> RefUnwindSafe for JsonField<'a>

§

impl<'a> Send for JsonField<'a>

§

impl<'a> Sync for JsonField<'a>

§

impl<'a> Unpin for JsonField<'a>

§

impl<'a> UnwindSafe for JsonField<'a>

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
§

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

§

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