Skip to main content

FeedbackAggregator

Struct FeedbackAggregator 

Source
pub struct FeedbackAggregator { /* private fields */ }
Expand description

Accumulates FeedbackEvents across sessions and summarizes them by corpus_id.

Serializable as a flat JSON array of events — same pattern as MetaTrainingRecord::save_list. Append is O(1) amortized; Self::summarize is O(N) per call, which is fine for the scale feedback naturally reaches (hundreds to thousands of events per corpus).

#[serde(transparent)] keeps the derive-based serializer (serde_json::to_string(&agg)) and the hand-rolled Self::save / Self::load path on the same JSON shape — a flat array of events. Without it, the derive would emit {"events": [...]} which load rejects.

Implementations§

Source§

impl FeedbackAggregator

Source

pub fn new() -> Self

Source

pub fn with_window(max_events: usize) -> Self

Construct with a bounded event window. Once the log reaches max_events, every new record call drops the oldest event so memory stays capped — appropriate for long-running services that only need recent feedback for per-corpus summaries.

Without this cap the event log grows indefinitely; on a 1 event/sec firehose that reaches 100 MB of JSON within a week.

Source

pub fn set_max_events(&mut self, max_events: Option<usize>)

Attach (or drop) the event-count cap after construction.

Source

pub fn len(&self) -> usize

Total number of accumulated events (across all corpus_ids).

Source

pub fn is_empty(&self) -> bool

Source

pub fn record(&mut self, event: FeedbackEvent)

Append one event. When a Self::with_window cap is set and the log is already at capacity, the oldest event is evicted first — a FIFO ring over the underlying Vec.

Source

pub fn events(&self) -> &[FeedbackEvent]

Read-only borrow of the raw event log.

Source

pub fn corpus_ids(&self) -> Vec<String>

Distinct corpus_ids that have any feedback attached.

Source

pub fn summarize(&self, corpus_id: &str) -> Option<FeedbackSummary>

Summarize feedback for a specific corpus. Returns None if the corpus has no events yet.

Source

pub fn summarize_all(&self) -> Vec<FeedbackSummary>

Summarize every corpus that has events. Sorted by corpus_id.

Source

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

Save this aggregator (event list) to a JSON file. Creates parent directories as needed.

Source

pub fn load(path: impl AsRef<Path>) -> Result<Self>

Load an aggregator from a JSON event-log file. Returns an empty aggregator if the file does not exist.

Accepts both a JSON array (legacy, what save writes for backward compat) and JSON Lines (new format written by FeedbackEvent::append_to_default_store and sibling append paths). Detection is first-character based.

Source

pub fn default_store_path() -> Result<PathBuf>

Default on-disk feedback log: ~/.sphereql/feedback_events.json. Parallel convention to MetaTrainingRecord::default_store_path.

Source

pub fn load_default_store() -> Result<Self>

Load the default on-disk feedback store. Empty aggregator if the store does not exist yet.

Trait Implementations§

Source§

impl Clone for FeedbackAggregator

Source§

fn clone(&self) -> FeedbackAggregator

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 FeedbackAggregator

Source§

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

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

impl Default for FeedbackAggregator

Source§

fn default() -> FeedbackAggregator

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

impl<'de> Deserialize<'de> for FeedbackAggregator

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 FeedbackAggregator

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

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