Struct flatcontainer::impls::slice::SliceRegion

pub struct SliceRegion<R: Region, O = Vec<<R as Region>::Index>> { /* private fields */ }

A container representing slices of data.

Reading from this region is more involved than for others, because the data only exists in an indexable representation. The read item is a ReadSlice, which can be iterated or indexed. However, it is not possible to represent the data as a slice, simply because the slice doesn’t exist.

Examples

We fill some data into a slice region and use the ReadSlice to extract it later.

use flatcontainer::{RegionPreference, Push, Region, SliceRegion};
let mut r = <SliceRegion<<String as RegionPreference>::Region>>::default();

let panagram_en = "The quick fox jumps over the lazy dog"
    .split(" ")
    .collect::<Vec<_>>();
let panagram_de = "Zwölf Boxkämpfer jagen Viktor quer über den großen Sylter Deich"
    .split(" ")
    .collect::<Vec<_>>();

let en_index = r.push(&panagram_en);
let de_index = r.push(&panagram_de);

assert!(panagram_de.into_iter().eq(r.index(de_index)));
assert!(panagram_en.into_iter().eq(r.index(en_index)));

assert_eq!(r.index(de_index).get(2), "jagen");

Trait Implementations

impl<R, O> Clone for SliceRegion<R, O>

where R: Region + Clone, O: Clone,

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 + Region, O: Debug> Debug for SliceRegion<R, O>

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

Formats the value using the given formatter.

impl<R: Region, O: OffsetContainer<R::Index>> Default for SliceRegion<R, O>

fn default() -> Self

Returns the “default value” for a type.

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

where R: Deserialize<'de> + Region, 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<'a, T, R, O, const N: usize> Push<&&'a [T; N]> for SliceRegion<R, O>

where R: Region + Push<&'a T>, O: OffsetContainer<R::Index>,

fn push(&mut self, item: &&'a [T; N]) -> <SliceRegion<R, O> as Region>::Index

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

impl<'a, C, T, O> Push<&&'a Vec<T>> for SliceRegion<C, O>

where C: Region + Push<&'a T>, O: OffsetContainer<C::Index>,

fn push(&mut self, item: &&'a Vec<T>) -> <SliceRegion<C, O> as Region>::Index

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

impl<'a, C, T, O> Push<&'a [T]> for SliceRegion<C, O>

where C: Region + Push<&'a T>, O: OffsetContainer<C::Index>,

fn push(&mut self, item: &'a [T]) -> <SliceRegion<C, O> as Region>::Index

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

impl<'a, T, R, O, const N: usize> Push<&'a [T; N]> for SliceRegion<R, O>

where R: Region + Push<&'a T>, O: OffsetContainer<R::Index>,

fn push(&mut self, item: &'a [T; N]) -> <SliceRegion<R, O> as Region>::Index

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

impl<C, T, O> Push<&Vec<T>> for SliceRegion<C, O>

where for<'a> C: Region + Push<&'a T>, O: OffsetContainer<C::Index>,

fn push(&mut self, item: &Vec<T>) -> <SliceRegion<C, O> as Region>::Index

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

impl<T, R, O, const N: usize> Push<[T; N]> for SliceRegion<R, O>

where for<'a> R: Region + Push<&'a T>, O: OffsetContainer<R::Index>,

fn push(&mut self, item: [T; N]) -> <SliceRegion<R, O> as Region>::Index

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

impl<'a, C, O> Push<ReadSlice<'a, C, O>> for SliceRegion<C, O>

where C: Region + Push<<C as Region>::ReadItem<'a>>, O: OffsetContainer<C::Index>,

fn push( &mut self, item: ReadSlice<'a, C, O>, ) -> <SliceRegion<C, O> as Region>::Index

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

impl<C, T, O> Push<Vec<T>> for SliceRegion<C, O>

where C: Region + Push<T>, O: OffsetContainer<C::Index>,

fn push(&mut self, item: Vec<T>) -> <SliceRegion<C, O> as Region>::Index

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

impl<R: Region, O: OffsetContainer<R::Index>> Region for SliceRegion<R, O>

type Owned = Vec<<R as Region>::Owned>

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

type ReadItem<'a> = ReadSlice<'a, R, O> where Self: 'a

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

type Index = (usize, 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, (start, end): 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<'a, T, R, O> ReserveItems<&'a [T]> for SliceRegion<R, O>

where R: Region + ReserveItems<&'a T>, O: OffsetContainer<R::Index>,

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

where I: Iterator<Item = &'a [T]> + Clone,

Ensure that the region can absorb items without reallocation.

impl<'a, T, R, O, const N: usize> ReserveItems<&'a [T; N]> for SliceRegion<R, O>

where R: Region + ReserveItems<&'a T>, O: OffsetContainer<R::Index>,

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

where I: Iterator<Item = &'a [T; N]> + Clone,

Ensure that the region can absorb items without reallocation.

impl<'a, T, R, O> ReserveItems<&'a Vec<T>> for SliceRegion<R, O>

where for<'b> R: Region + ReserveItems<&'b T>, O: OffsetContainer<R::Index>,

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

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

Ensure that the region can absorb items without reallocation.

impl<'a, R, O> ReserveItems<ReadSlice<'a, R, O>> for SliceRegion<R, O>

where R: Region + ReserveItems<<R as Region>::ReadItem<'a>> + 'a, O: OffsetContainer<R::Index>,

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

where I: Iterator<Item = ReadSlice<'a, R, O>> + Clone,

Ensure that the region can absorb items without reallocation.

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

where R: Serialize + Region, O: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.