Trait zerovec::map::vecs::ZeroVecLike

source ·

pub trait ZeroVecLike<T: ?Sized> {
    type GetType: ?Sized + 'static;
    type SliceVariant: ZeroVecLike<T, GetType = Self::GetType> + ?Sized;

Show 13 methods    // Required methods
    fn zvl_new_borrowed() -> &'static Self::SliceVariant;
    fn zvl_binary_search(&self, k: &T) -> Result<usize, usize>
       where T: Ord;
    fn zvl_binary_search_in_range(
        &self,
        k: &T,
        range: Range<usize>,
    ) -> Option<Result<usize, usize>>
       where T: Ord;
    fn zvl_binary_search_by(
        &self,
        predicate: impl FnMut(&T) -> Ordering,
    ) -> Result<usize, usize>;
    fn zvl_binary_search_in_range_by(
        &self,
        predicate: impl FnMut(&T) -> Ordering,
        range: Range<usize>,
    ) -> Option<Result<usize, usize>>;
    fn zvl_get(&self, index: usize) -> Option<&Self::GetType>;
    fn zvl_len(&self) -> usize;
    fn zvl_as_borrowed(&self) -> &Self::SliceVariant;
    fn zvl_get_as_t<R>(g: &Self::GetType, f: impl FnOnce(&T) -> R) -> R;

    // Provided methods
    fn zvl_is_ascending(&self) -> bool
       where T: Ord { ... }
    fn zvl_is_empty(&self) -> bool { ... }
    fn t_cmp_get(t: &T, g: &Self::GetType) -> Ordering
       where T: Ord { ... }
    fn get_cmp_get(a: &Self::GetType, b: &Self::GetType) -> Ordering
       where T: Ord { ... }
}

Expand description

Trait abstracting over ZeroVec and VarZeroVec, for use in ZeroMap. You should not be implementing or calling this trait directly.

The T type is the type received by Self::zvl_binary_search(), as well as the one used for human-readable serialization.

Methods are prefixed with zvl_* to avoid clashes with methods on the types themselves

Required Associated Types§

source

type GetType: ?Sized + 'static

The type returned by Self::get()

source

type SliceVariant: ZeroVecLike<T, GetType = Self::GetType> + ?Sized

A fully borrowed version of this

Required Methods§

source

fn zvl_new_borrowed() -> &'static Self::SliceVariant

Create a new, empty borrowed variant

source

fn zvl_binary_search(&self, k: &T) -> Result<usize, usize>
where T: Ord,

Search for a key in a sorted vector, returns Ok(index) if found, returns Err(insert_index) if not found, where insert_index is the index where it should be inserted to maintain sort order.

source

fn zvl_binary_search_in_range( &self, k: &T, range: Range<usize>, ) -> Option<Result<usize, usize>>
where T: Ord,

Search for a key within a certain range in a sorted vector. Returns None if the range is out of bounds, and Ok or Err in the same way as zvl_binary_search. Indices are returned relative to the start of the range.

source

fn zvl_binary_search_by( &self, predicate: impl FnMut(&T) -> Ordering, ) -> Result<usize, usize>

Search for a key in a sorted vector by a predicate, returns Ok(index) if found, returns Err(insert_index) if not found, where insert_index is the index where it should be inserted to maintain sort order.

source

fn zvl_binary_search_in_range_by( &self, predicate: impl FnMut(&T) -> Ordering, range: Range<usize>, ) -> Option<Result<usize, usize>>

Search for a key within a certain range in a sorted vector by a predicate. Returns None if the range is out of bounds, and Ok or Err in the same way as zvl_binary_search. Indices are returned relative to the start of the range.

source

fn zvl_get(&self, index: usize) -> Option<&Self::GetType>

Get element at index

source

fn zvl_len(&self) -> usize

The length of this vector

source

fn zvl_as_borrowed(&self) -> &Self::SliceVariant

Construct a borrowed variant by borrowing from &self.

This function behaves like &'b self -> Self::SliceVariant<'b>, where 'b is the lifetime of the reference to this object.

Note: We rely on the compiler recognizing 'a and 'b as covariant and casting &'b Self<'a> to &'b Self<'b> when this gets called, which works out for ZeroVec and VarZeroVec containers just fine.

source