Struct ConsecutiveOffsetPairs

pub struct ConsecutiveOffsetPairs<R, O = OffsetOptimized> { /* private fields */ }

Transform an index of (usize, usize) to a sequence of 0... Requires the pairs to be dense, i.e., (i, j) is followed by (j, k).

Defers to region R for storing items, and uses offset container O to remeber indices. By default, O is Vec<usize>.

Examples

The following example shows that two inserts into a copy region have a collapsible index:

use flatcontainer::impls::deduplicate::{CollapseSequence, ConsecutiveOffsetPairs};
use flatcontainer::{Push, OwnedRegion, Region, StringRegion};
let mut r = <ConsecutiveOffsetPairs<OwnedRegion<u8>>>::default();

let index: usize = r.push(&b"abc");
assert_eq!(b"abc", r.index(index));

Trait Implementations

impl<R: Clone, O: Clone> Clone for ConsecutiveOffsetPairs<R, O>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug, O: Debug> Debug for ConsecutiveOffsetPairs<R, O>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R, O> Default for ConsecutiveOffsetPairs<R, O>

where R: Default, O: OffsetContainer<usize>,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, R, O> Deserialize<'de> for ConsecutiveOffsetPairs<R, O>

where R: Deserialize<'de>, O: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<R, O, T> Push<T> for ConsecutiveOffsetPairs<R, O>

where R: Region<Index = (usize, usize)> + Push<T>, O: OffsetContainer<usize>,

fn push(&mut self, item: T) -> <ConsecutiveOffsetPairs<R, O> as Region>::Index

Push item into self, returning an index that allows to look up the corresponding read item.

impl<R, O> Region for ConsecutiveOffsetPairs<R, O>

where R: Region<Index = (usize, usize)>, O: OffsetContainer<usize>,

type Owned = <R as Region>::Owned

An owned type that can be constructed from a read item.

type ReadItem<'a> = <R as Region>::ReadItem<'a> where Self: 'a

The type of the data that one gets out of the container.

type Index = usize

The type to index into the container. Should be treated as an opaque type, even if known.

fn merge_regions<'a>(regions: impl Iterator<Item = &'a Self> + Clone) -> Self

where Self: 'a,

Construct a region that can absorb the contents of regions in the future.

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

Index into the container. The index must be obtained by pushing data into the container.

fn reserve_regions<'a, I>(&mut self, regions: I)

where Self: 'a, I: Iterator<Item = &'a Self> + Clone,

Ensure that the region can absorb the items of regions without reallocation

fn clear(&mut self)

Remove all elements from this region, but retain allocations if possible.

fn heap_size<F: FnMut(usize, usize)>(&self, callback: F)

Heap size, size - capacity

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

where Self: 'a,

Converts a read item into one with a narrower lifetime.

impl<R, O, T> ReserveItems<T> for ConsecutiveOffsetPairs<R, O>

where R: Region<Index = (usize, usize)> + ReserveItems<T>, O: OffsetContainer<usize>,

fn reserve_items<I>(&mut self, items: I)

where I: Iterator<Item = T> + Clone,

Ensure that the region can absorb items without reallocation.

impl<R, O> Serialize for ConsecutiveOffsetPairs<R, O>

where R: Serialize, O: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.