Trait BatchContainer

pub trait BatchContainer: 'static {
    type Owned: Clone + Ord;
    type ReadItem<'a>: Copy + Ord;

    // Required methods
    fn into_owned<'a>(item: Self::ReadItem<'a>) -> Self::Owned;
    fn push_ref(&mut self, item: Self::ReadItem<'_>);
    fn push_own(&mut self, item: &Self::Owned);
    fn clear(&mut self);
    fn with_capacity(size: usize) -> Self;
    fn merge_capacity(cont1: &Self, cont2: &Self) -> Self;
    fn reborrow<'b, 'a: 'b>(item: Self::ReadItem<'a>) -> Self::ReadItem<'b>;
    fn index(&self, index: usize) -> Self::ReadItem<'_>;
    fn len(&self) -> usize;

    // Provided methods
    fn clone_onto<'a>(item: Self::ReadItem<'a>, other: &mut Self::Owned) { ... }
    fn get(&self, index: usize) -> Option<Self::ReadItem<'_>> { ... }
    fn last(&self) -> Option<Self::ReadItem<'_>> { ... }
    fn is_empty(&self) -> bool { ... }
    fn advance<F: for<'a> Fn(Self::ReadItem<'a>) -> bool>(
        &self,
        start: usize,
        end: usize,
        function: F,
    ) -> usize { ... }
}

A general-purpose container resembling Vec<T>.

Required Associated Types

type Owned: Clone + Ord

An owned instance of Self::ReadItem<'_>.

type ReadItem<'a>: Copy + Ord

The type that can be read back out of the container.

Required Methods

fn into_owned<'a>(item: Self::ReadItem<'a>) -> Self::Owned

Conversion from an instance of this type to the owned type.

fn push_ref(&mut self, item: Self::ReadItem<'_>)

Push an item into this container

fn push_own(&mut self, item: &Self::Owned)

Push an item into this container

fn clear(&mut self)

Clears the container. May not release resources.

fn with_capacity(size: usize) -> Self

Creates a new container with sufficient capacity.

fn merge_capacity(cont1: &Self, cont2: &Self) -> Self

Creates a new container with sufficient capacity.

fn reborrow<'b, 'a: 'b>(item: Self::ReadItem<'a>) -> Self::ReadItem<'b>

Converts a read item into one with a narrower lifetime.

fn index(&self, index: usize) -> Self::ReadItem<'_>

Reference to the element at this position.

fn len(&self) -> usize

Number of contained elements

Provided Methods

fn clone_onto<'a>(item: Self::ReadItem<'a>, other: &mut Self::Owned)

Clones self onto an existing instance of the owned type.

fn get(&self, index: usize) -> Option<Self::ReadItem<'_>>

Reference to the element at this position, if it exists.

fn last(&self) -> Option<Self::ReadItem<'_>>

Returns the last item if the container is non-empty.

fn is_empty(&self) -> bool

Indicates if the length is zero.

fn advance<F: for<'a> Fn(Self::ReadItem<'a>) -> bool>( &self, start: usize, end: usize, function: F, ) -> usize

Reports the number of elements satisfying the predicate.

This methods relies strongly on the assumption that the predicate stays false once it becomes false, a joint property of the predicate and the layout of Self. This allows advance` to use exponential search to count the number of elements in time logarithmic in the result.

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<T: Ord + Clone + 'static> BatchContainer for Vec<T>

type Owned = T

type ReadItem<'a> = &'a T

fn into_owned<'a>(item: Self::ReadItem<'a>) -> Self::Owned

fn clone_onto<'a>(item: Self::ReadItem<'a>, other: &mut Self::Owned)

fn reborrow<'b, 'a: 'b>(item: Self::ReadItem<'a>) -> Self::ReadItem<'b>

fn push_ref(&mut self, item: Self::ReadItem<'_>)

fn push_own(&mut self, item: &Self::Owned)

fn clear(&mut self)

fn with_capacity(size: usize) -> Self

fn merge_capacity(cont1: &Self, cont2: &Self) -> Self

fn index(&self, index: usize) -> Self::ReadItem<'_>

fn get(&self, index: usize) -> Option<Self::ReadItem<'_>>

fn len(&self) -> usize

Implementors

impl BatchContainer for OffsetList

type Owned = usize

type ReadItem<'a> = usize

impl<B> BatchContainer for SliceContainer<B>

where B: Ord + Clone + Sized + 'static,

type Owned = Vec<B>

type ReadItem<'a> = &'a [B]

impl<B: Ord + Clone + 'static> BatchContainer for HuffmanContainer<B>

type Owned = Vec<B>

type ReadItem<'a> = Wrapped<'a, B>

impl<T: Clone + Ord + Columnation + 'static> BatchContainer for TimelyStack<T>

type Owned = T

type ReadItem<'a> = &'a T