Struct CombinedState 

pub struct CombinedState<V>
where
    V: Clone + Debug + Ord,
{ /* private fields */ }

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.

Examples

use fluxion_stream::CombinedState;

let state = CombinedState::new(vec![1, 2, 3]);
assert_eq!(state.values().len(), 3);
assert_eq!(state.values()[0], 1);

Implementations

impl<V> CombinedState<V>

where V: Clone + Debug + Ord,

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

Creates a new CombinedState with the given vector of values.

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

Returns a reference to the internal values vector.

pub fn len(&self) -> usize

Returns the number of streams in the combined state.

pub fn is_empty(&self) -> bool

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

Trait Implementations

impl<V> Clone for CombinedState<V>

where V: Clone + Debug + Ord + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V> Debug for CombinedState<V>

where V: Clone + Debug + Ord + Debug,

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

Formats the value using the given formatter.

impl<V> Ord for CombinedState<V>

where V: Clone + Debug + Ord + Ord,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<V> Ordered for CombinedState<V>

where V: Clone + Debug + Ord,

type Inner = CombinedState<V>

The type of the inner value wrapped by this ordered type

fn order(&self) -> u64

Returns the ordering value for this item. Stream operators use this to determine the order of items.

fn get(&self) -> &Self::Inner

Gets a reference to the inner value.

fn with_order(value: Self::Inner, _order: u64) -> Self

Creates a new instance wrapping the given value with the specified order.

fn into_inner(self) -> Self::Inner

Gets the inner value, consuming the wrapper.

fn map_inner<F, U>(self, f: F, order: u64) -> impl Ordered<Inner = U>

where F: FnOnce(Self::Inner) -> U, U: Clone, Self: Sized,

Creates a new instance with a different inner type. This is used by operators like combine_latest that transform the inner value.

impl<V> PartialEq for CombinedState<V>

where V: Clone + Debug + Ord + PartialEq,

fn eq(&self, other: &CombinedState<V>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<V> PartialOrd for CombinedState<V>

where V: Clone + Debug + Ord + PartialOrd,

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<V> Eq for CombinedState<V>

where V: Clone + Debug + Ord + Eq,

impl<V> StructuralPartialEq for CombinedState<V>

where V: Clone + Debug + Ord,