CombinedState

Struct CombinedState 

Source
pub struct CombinedState<V, TS = u64>
where V: Clone + Debug + Ord, TS: Clone + Debug + Ord,
{ /* private fields */ }
Expand description

State container holding the latest values from multiple combined streams.

Used by operators that combine multiple streams such as combine_latest, with_latest_from, and emit_when.

Each value is paired with its original timestamp, enabling detection of transient states when combining multiple subscribers from the same shared source.

§Examples

use fluxion_stream::CombinedState;

let state = CombinedState::new(vec![(1, 100u64), (2, 100u64), (3, 100u64)], 100u64);
assert_eq!(state.values().len(), 3);
assert_eq!(state.values()[0], 1);
// All timestamps match - this is a stable state
assert!(state.timestamps().iter().all(|ts| *ts == 100));

Implementations§

Source§

impl<V, TS> CombinedState<V, TS>
where V: Clone + Debug + Ord, TS: Clone + Debug + Ord,

Source

pub fn new(state: Vec<(V, TS)>, timestamp: TS) -> Self

Creates a new CombinedState with the given vector of value-timestamp pairs and max timestamp.

Source

pub fn values(&self) -> Vec<V>

Returns the values as a vector.

If you need access to individual timestamps, use pairs() or timestamps() instead.

Source

pub fn timestamps(&self) -> Vec<TS>

Returns the values as a vector of timestamps.

Source

pub fn pairs(&self) -> &[(V, TS)]

Returns a slice of the raw value-timestamp pairs.

Source

pub fn len(&self) -> usize

Returns the number of streams in the combined state.

Source

pub fn is_empty(&self) -> bool

Returns true if there are no streams in the combined state.

Trait Implementations§

Source§

impl<V, TS> Clone for CombinedState<V, TS>
where V: Clone + Debug + Ord + Clone, TS: Clone + Debug + Ord + Clone,

Source§

fn clone(&self) -> CombinedState<V, TS>

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<V, TS> Debug for CombinedState<V, TS>
where V: Clone + Debug + Ord + Debug, TS: Clone + Debug + Ord + Debug,

Source§

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

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

impl<V, TS> HasTimestamp for CombinedState<V, TS>
where V: Clone + Debug + Ord, TS: Clone + Debug + Ord + Copy + Send + Sync,

Source§

type Timestamp = TS

The type representing the timestamp
Source§

fn timestamp(&self) -> Self::Timestamp

Returns the timestamp value for this item. Stream operators use this to determine the order of items.
Source§

impl<V, TS> Ord for CombinedState<V, TS>
where V: Clone + Debug + Ord + Ord, TS: Clone + Debug + Ord + Ord,

Source§

fn cmp(&self, other: &CombinedState<V, TS>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<V, TS> PartialEq for CombinedState<V, TS>
where V: Clone + Debug + Ord + PartialEq, TS: Clone + Debug + Ord + PartialEq,

Source§

fn eq(&self, other: &CombinedState<V, TS>) -> 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<V, TS> PartialOrd for CombinedState<V, TS>
where V: Clone + Debug + Ord + PartialOrd, TS: Clone + Debug + Ord + PartialOrd,

Source§

fn partial_cmp(&self, other: &CombinedState<V, TS>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<V, TS> Timestamped for CombinedState<V, TS>
where V: Clone + Debug + Ord, TS: Clone + Debug + Ord + Copy + Send + Sync,

Source§

type Inner = CombinedState<V, TS>

The type of the inner value wrapped by this timestamped type
Source§

fn with_timestamp(value: Self::Inner, timestamp: Self::Timestamp) -> Self

Creates a new instance wrapping the given value with the specified timestamp.
Source§

fn into_inner(self) -> Self::Inner

Consumes self and returns the inner value. For wrapper types like Sequenced<T>, this extracts T. For domain types where Inner = Self, this typically returns self.
Source§

impl<V, TS> Eq for CombinedState<V, TS>
where V: Clone + Debug + Ord + Eq, TS: Clone + Debug + Ord + Eq,

Source§

impl<V, TS> StructuralPartialEq for CombinedState<V, TS>
where V: Clone + Debug + Ord, TS: Clone + Debug + Ord,

Auto Trait Implementations§

§

impl<V, TS> Freeze for CombinedState<V, TS>
where TS: Freeze,

§

impl<V, TS> RefUnwindSafe for CombinedState<V, TS>

§

impl<V, TS> Send for CombinedState<V, TS>
where TS: Send, V: Send,

§

impl<V, TS> Sync for CombinedState<V, TS>
where TS: Sync, V: Sync,

§

impl<V, TS> Unpin for CombinedState<V, TS>
where TS: Unpin, V: Unpin,

§

impl<V, TS> UnwindSafe for CombinedState<V, TS>
where TS: UnwindSafe, V: UnwindSafe,

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> 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.