Struct SortByKey

pub struct SortByKey<S, F>
where
    S: Stream,
    S::Item: VectorDiffContainer,
{ /* private fields */ }

A VectorDiff stream adapter that presents a sorted view of the underlying ObservableVector items.

Sorting is done by transforming items to a key with a custom function and comparing those. Otherwise this adapter works exactly like Sort, see that type’s documentation for details on how this adapter operates.

Implementations

impl<S, F, K> SortByKey<S, F>

where S: Stream, S::Item: VectorDiffContainer, F: Fn(&VectorDiffContainerStreamElement<S>) -> K, K: Ord,

pub fn new( initial_values: Vector<VectorDiffContainerStreamElement<S>>, inner_stream: S, key_fn: F, ) -> (Vector<VectorDiffContainerStreamElement<S>>, Self)

Create a new SortByKey with the given (unsorted) initial values, stream of VectorDiff updates for those values, and the key function.

Trait Implementations

impl<S, F, K> Stream for SortByKey<S, F>

where S: Stream, S::Item: VectorDiffContainer, F: Fn(&VectorDiffContainerStreamElement<S>) -> K, K: Ord,

type Item = <S as Stream>::Item

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, S, F> Unpin for SortByKey<S, F>

where PinnedFieldsOf<__Origin<'__pin, S, F>>: Unpin, S: Stream, S::Item: VectorDiffContainer,