Struct flatcontainer::impls::string::StringRegion

pub struct StringRegion<R = OwnedRegion<u8>> { /* private fields */ }

A region to store strings and read &str.

Delegates to a region R to store u8 slices. By default, it uses a OwnedRegion, but a different region can be provided, as long as it absorbs and reads items as &[u8].

Note that all implementations of Push<T> for StringRegion must only accept valid utf-8 data because the region does not validate the contents when indexing.

Examples

We fill some data into a string region and use extract it later.

use flatcontainer::{RegionPreference, Push, OwnedRegion, Region, StringRegion};
let mut r = <StringRegion>::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);
let de_index = r.push(panagram_de);

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

Trait Implementations

impl<R: Clone> Clone for StringRegion<R>

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> Debug for StringRegion<R>

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

Formats the value using the given formatter.

impl<R: Default> Default for StringRegion<R>

fn default() -> StringRegion<R>

Returns the “default value” for a type.

impl<'de, R> Deserialize<'de> for StringRegion<R>

where R: 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> Push<&&str> for StringRegion<R>

where for<'a> R: Region<ReadItem<'a> = &'a [u8]> + Push<&'a [u8]> + 'a,

fn push(&mut self, item: &&str) -> <StringRegion<R> as Region>::Index

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

impl<R> Push<&String> for StringRegion<R>

where for<'a> R: Region<ReadItem<'a> = &'a [u8]> + Push<&'a [u8]> + 'a,

fn push(&mut self, item: &String) -> <StringRegion<R> as Region>::Index

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

impl<R> Push<&str> for StringRegion<R>

where for<'a> R: Region<ReadItem<'a> = &'a [u8]> + Push<&'a [u8]> + 'a,

fn push(&mut self, item: &str) -> <StringRegion<R> as Region>::Index

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

impl<R> Push<String> for StringRegion<R>

where for<'a> R: Region<ReadItem<'a> = &'a [u8]> + Push<&'a [u8]> + 'a,

fn push(&mut self, item: String) -> <StringRegion<R> as Region>::Index

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

impl<R> Region for StringRegion<R>

where for<'a> R: Region<ReadItem<'a> = &'a [u8]> + 'a,

type Owned = String

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

type ReadItem<'a> = &'a str where Self: 'a

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

type Index = <R as Region>::Index

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<'a, 'b: 'a, R> ReserveItems<&'a &'b str> for StringRegion<R>

where for<'c> R: Region<ReadItem<'c> = &'c [u8]> + ReserveItems<&'c [u8]> + 'c,

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

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

Ensure that the region can absorb items without reallocation.

impl<'b, R> ReserveItems<&'b String> for StringRegion<R>

where for<'a> R: Region<ReadItem<'a> = &'a [u8]> + ReserveItems<&'a [u8]> + 'a,

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

where I: Iterator<Item = &'b String> + Clone,

Ensure that the region can absorb items without reallocation.

impl<'b, R> ReserveItems<&'b str> for StringRegion<R>

where for<'a> R: Region<ReadItem<'a> = &'a [u8]> + ReserveItems<&'a [u8]> + 'a,

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

where I: Iterator<Item = &'b str> + Clone,

Ensure that the region can absorb items without reallocation.

impl<R> Serialize for StringRegion<R>

where R: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.