Struct OwnedRegion

pub struct OwnedRegion<T> { /* private fields */ }

A container for owned types.

The container can absorb any type, and stores an owned version of the type, similarly to what vectors do. We recommend using this container for copy types, but there is no restriction in the implementation, and in fact it can correctly store owned values, although any data owned by T is regular heap-allocated data, and not contained in regions.

Examples

use flatcontainer::{Push, OwnedRegion, Region};
let mut r = <OwnedRegion<_>>::default();

let panagram_en = "The quick fox jumps over the lazy dog";
let panagram_de = "Zwölf Boxkämpfer jagen Viktor quer über den großen Sylter Deich";

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

assert_eq!(panagram_de.as_bytes(), r.index(de_index));
assert_eq!(panagram_en.as_bytes(), r.index(en_index));

Trait Implementations

impl<T: Clone> Clone for OwnedRegion<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for OwnedRegion<T>

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

Formats the value using the given formatter.

impl<T> Default for OwnedRegion<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for OwnedRegion<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Clone> Push<&&[T]> for OwnedRegion<T>

where for<'a> Self: Push<&'a [T]>,

fn push(&mut self, item: &&[T]) -> <OwnedRegion<T> as Region>::Index

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

impl<T: Clone, const N: usize> Push<&&[T; N]> for OwnedRegion<T>

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

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

impl<T: Clone> Push<&[T]> for OwnedRegion<T>

fn push(&mut self, item: &[T]) -> <OwnedRegion<T> as Region>::Index

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

impl<T: Clone, const N: usize> Push<&[T; N]> for OwnedRegion<T>

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

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

impl<T: Clone> Push<&Vec<T>> for OwnedRegion<T>

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

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

impl<T, const N: usize> Push<[T; N]> for OwnedRegion<T>

where [T]: ToOwned,

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

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

impl<T: Clone, I: IntoIterator<Item = T>> Push<CopyIter<I>> for OwnedRegion<T>

fn push(&mut self, item: CopyIter<I>) -> <OwnedRegion<T> as Region>::Index

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

impl<T> Push<Vec<T>> for OwnedRegion<T>

where [T]: ToOwned,

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

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

impl<T> Region for OwnedRegion<T>

where [T]: ToOwned,

type Owned = <[T] as ToOwned>::Owned

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

type ReadItem<'a> = &'a [T] 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<'b, T> ReserveItems<&'b [T]> for OwnedRegion<T>

where [T]: ToOwned,

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

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

Ensure that the region can absorb items without reallocation.

impl<'b, T: Clone, const N: usize> ReserveItems<&'b [T; N]> for OwnedRegion<T>

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

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

Ensure that the region can absorb items without reallocation.

impl<'a, T> ReserveItems<&'a Vec<T>> for OwnedRegion<T>

where [T]: ToOwned,

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<T, J: IntoIterator<Item = T>> ReserveItems<CopyIter<J>> for OwnedRegion<T>

where [T]: ToOwned,

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

where I: Iterator<Item = CopyIter<J>> + Clone,

Ensure that the region can absorb items without reallocation.

impl<T> Serialize for OwnedRegion<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.