Struct RealtimePayloadHistory 

pub struct RealtimePayloadHistory<P> { /* private fields */ }

Payloads retained at exact text/audio coordinates for one speech schedule.

Implementations

impl<P> RealtimePayloadHistory<P>

pub fn new(schedule: RealtimeSpeechConfig) -> Self

Creates an empty pre-first-frame history bound only to one exact schedule.

A payload contract must be bound before any coordinate payload can be published. This unbound form exists because session batch is not known until the first frame is accepted.

pub fn with_contract(contract: RealtimePayloadContract) -> Self

Creates an empty history bound to one complete payload contract.

pub const fn schedule(&self) -> &RealtimeSpeechConfig

Returns the exact normalized schedule bound to this history.

pub const fn contract(&self) -> Option<&RealtimePayloadContract>

Returns the exact payload contract after first-frame binding.

pub fn bind_or_validate_contract( &mut self, contract: &RealtimePayloadContract, ) -> Result<(), RealtimePayloadHistoryError>

Binds the first complete contract or validates an already-bound history.

Failed validation never changes the current contract or payloads.

pub fn validate_successor( &self, successor: &Self, ) -> Result<(), RealtimePayloadHistoryError>

Validates whether a branch history may replace this canonical history.

pub fn len(&self) -> usize

Returns the number of retained coordinate payloads.

pub fn is_empty(&self) -> bool

Returns whether no payloads are retained.

pub fn validate_schedule( &self, schedule: &RealtimeSpeechConfig, ) -> Result<(), RealtimePayloadHistoryError>

Rejects handoff to any materially different normalized schedule.

pub fn delayed_coordinate( &self, schedule: &RealtimeSpeechConfig, base_position: usize, slot: RealtimeFrameSlot, ) -> Result<RealtimeSlotCoordinate, RealtimePayloadHistoryError>

Resolves an absolute coordinate by adding the exact configured slot delay.

This is only coordinate arithmetic; it does not assign temporal-input or prediction-target meaning to the resulting slot.

pub fn insert( &mut self, schedule: &RealtimeSpeechConfig, coordinate: RealtimeSlotCoordinate, payload: P, ) -> Result<(), RealtimePayloadHistoryError>

Inserts one payload at one exact validated coordinate.

pub fn insert_delayed( &mut self, schedule: &RealtimeSpeechConfig, base_position: usize, slot: RealtimeFrameSlot, payload: P, ) -> Result<RealtimeSlotCoordinate, RealtimePayloadHistoryError>

Calculates one delayed coordinate and inserts its payload atomically.

pub fn insert_many( &mut self, schedule: &RealtimeSpeechConfig, payloads: impl IntoIterator<Item = (RealtimeSlotCoordinate, P)>, ) -> Result<(), RealtimePayloadHistoryError>

Inserts a complete set of coordinate payloads as one publication.

Invalid slots and duplicates are detected before any payload is visible.

pub fn overwrite_many( &mut self, schedule: &RealtimeSpeechConfig, payloads: impl IntoIterator<Item = (RealtimeSlotCoordinate, P)>, ) -> Result<(), RealtimePayloadHistoryError>

Atomically publishes validated coordinate payloads with explicit overwrite semantics.

This is reserved for schedule-authorized placement and target updates. Ordinary admission should use Self::insert_many so accidental duplicate producers still fail closed.

pub fn get( &self, schedule: &RealtimeSpeechConfig, coordinate: RealtimeSlotCoordinate, ) -> Result<Option<&P>, RealtimePayloadHistoryError>

Returns a payload at one exact validated coordinate, when present.

pub fn envelope( &self, schedule: &RealtimeSpeechConfig, coordinate: RealtimeSlotCoordinate, ) -> Result<Option<&RealtimePayloadEnvelope<P>>, RealtimePayloadHistoryError>

Returns the typed envelope at one exact validated coordinate, when present.

pub fn required( &self, schedule: &RealtimeSpeechConfig, coordinate: RealtimeSlotCoordinate, ) -> Result<&P, RealtimePayloadHistoryError>

Resolves one required payload or fails with its exact missing coordinate.

pub fn resolve_required( &self, schedule: &RealtimeSpeechConfig, coordinates: impl IntoIterator<Item = RealtimeSlotCoordinate>, ) -> Result<Vec<&P>, RealtimePayloadHistoryError>

Resolves required coordinates in caller order, retaining duplicate reads.

pub fn prune_for_next_frontier( &mut self, schedule: &RealtimeSpeechConfig, next_frontier: usize, ) -> Result<usize, RealtimePayloadHistoryError>

Prunes coordinates older than the deterministic delayed-history window.

For next frontier n and maximum delay d, positions before n - (d + 2) are removed. The additional position retains the oldest payload referenced by the just-submitted transition until its completion has captured Self::retained_values. Warm-up clamps the minimum position to zero. The return value is the number of payloads removed.

pub fn retained_values(&self) -> impl Iterator<Item = &P>

Iterates retained payloads in stable coordinate order.

pub fn envelopes(&self) -> impl Iterator<Item = &RealtimePayloadEnvelope<P>>

Iterates retained typed envelopes in stable coordinate order.

pub fn entries(&self) -> impl Iterator<Item = (RealtimeSlotCoordinate, &P)>

Iterates exact coordinates and retained payloads in stable order.

Trait Implementations

impl<P: Clone> Clone for RealtimePayloadHistory<P>

fn clone(&self) -> RealtimePayloadHistory<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for RealtimePayloadHistory<P>

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

Formats the value using the given formatter.

impl<P: Eq> Eq for RealtimePayloadHistory<P>

impl<P: PartialEq> PartialEq for RealtimePayloadHistory<P>

fn eq(&self, other: &RealtimePayloadHistory<P>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<P: PartialEq> StructuralPartialEq for RealtimePayloadHistory<P>