Trait ConsolidateLayout

pub trait ConsolidateLayout: DrainContainer {
    type Key<'a>: Eq
       where Self: 'a;
    type Diff<'a>;
    type DiffOwned: for<'a> Semigroup<Self::Diff<'a>>;

    // Required methods
    fn owned_diff(diff: Self::Diff<'_>) -> Self::DiffOwned;
    fn into_parts(item: Self::Item<'_>) -> (Self::Key<'_>, Self::Diff<'_>);
    fn push_with_diff(&mut self, key: Self::Key<'_>, diff: Self::DiffOwned);
    fn cmp(item1: &Self::Item<'_>, item2: &Self::Item<'_>) -> Ordering;
    fn len(&self) -> usize;
    fn clear(&mut self);

    // Provided method
    fn consolidate_into(&mut self, target: &mut Self) { ... }
}

Layout of containers and their read items to be consolidated.

This trait specifies behavior to extract keys and diffs from container’s read items. Consolidation accumulates the diffs per key.

The trait requires Container to have access to its Item GAT.

Required Associated Types

type Key<'a>: Eq where Self: 'a

Key portion of data, essentially everything minus the diff

type Diff<'a>

GAT diff type.

type DiffOwned: for<'a> Semigroup<Self::Diff<'a>>

Owned diff type.

Required Methods

fn owned_diff(diff: Self::Diff<'_>) -> Self::DiffOwned

Converts a reference diff into an owned diff.

fn into_parts(item: Self::Item<'_>) -> (Self::Key<'_>, Self::Diff<'_>)

Deconstruct an item into key and diff. Must be cheap.

fn push_with_diff(&mut self, key: Self::Key<'_>, diff: Self::DiffOwned)

Push an element to a compatible container.

This function is odd to have, so let’s explain why it exists. Ideally, the container would accept a (key, diff) pair and we wouldn’t need this function. However, we might never be in a position where this is true: Vectors can push any T, which would collide with a specific implementation for pushing tuples of mixes GATs and owned types.

For this reason, we expose a function here that takes a GAT key and an owned diff, and leave it to the implementation to “patch” a suitable item that can be pushed into self.

fn cmp(item1: &Self::Item<'_>, item2: &Self::Item<'_>) -> Ordering

Compare two items by key to sort containers.

fn len(&self) -> usize

Returns the number of items in the container.

fn clear(&mut self)

Clear the container. Afterwards, len() should return 0.

Provided Methods

fn consolidate_into(&mut self, target: &mut Self)

Consolidate the supplied container.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<D, T, R> ConsolidateLayout for Vec<(D, T, R)>

where D: Ord + Clone + 'static, T: Ord + Clone + 'static, R: Semigroup + Clone + 'static,

fn consolidate_into(&mut self, target: &mut Self)

Consolidate the supplied container.

type Key<'a> = (D, T) where Self: 'a

type Diff<'a> = R where Self: 'a

type DiffOwned = R

fn owned_diff(diff: Self::Diff<'_>) -> Self::DiffOwned

fn into_parts( (data, time, diff): Self::Item<'_>, ) -> (Self::Key<'_>, Self::Diff<'_>)

fn cmp<'a>(item1: &Self::Item<'_>, item2: &Self::Item<'_>) -> Ordering

fn push_with_diff(&mut self, (data, time): Self::Key<'_>, diff: Self::DiffOwned)

fn len(&self) -> usize

fn clear(&mut self)

Implementors