Struct index_ext::tag::Capacity

pub struct Capacity<Tag> { /* private fields */ }

A number that overestimates the guaranteed size of a number of slices.

This is the counter part of Prefix. It encapsulates a field that is guaranteed to be at least the size of all indices with the exact same tag. In other words, all slices at least as long as this number are safe to be accessed by indices.

Implementations

impl<T: Tag> Capacity<T>

pub fn with_tag<NewT>(self, less: TagLessEq<NewT, T>) -> Capacity<NewT>

Interpret this with the tag of a set of potentially shorter slices.

The proof of inequality was performed in any of the possible constructors that allow the instance of TagLessEq to exist in the first place.

pub fn get(self) -> usize

Returns the stored length.

pub fn saturating_add(self, add: usize) -> Self

Create a larger capacity.

pub fn ensure(self, min: usize) -> Self

Bound the length from below.

Trait Implementations

impl<Tag: Clone> Clone for Capacity<Tag>

fn clone(&self) -> Capacity<Tag>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Tag: Copy> Copy for Capacity<Tag>