timely::container::flatcontainer

Struct StringRegion

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

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§

Source§

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

Source§

fn clone(&self) -> StringRegion<R>

Returns a copy of the value. Read more
Source§

fn clone_from(&mut self, source: &StringRegion<R>)

Performs copy-assignment from source. Read more
Source§

impl<R> Debug for StringRegion<R>
where R: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> StringRegion<R>

Returns the “default value” for a type. Read more
Source§

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

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<StringRegion<R>, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

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

Source§

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.
Source§

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

Source§

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.
Source§

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

Source§

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.
Source§

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

Source§

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.
Source§

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

Source§

type Owned = String

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

type ReadItem<'a> = &'a str where StringRegion<R>: 'a

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

type Index = <R as Region>::Index

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

fn merge_regions<'a>( regions: impl Iterator<Item = &'a StringRegion<R>> + Clone, ) -> StringRegion<R>
where StringRegion<R>: 'a,

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

fn index( &self, index: <StringRegion<R> as Region>::Index, ) -> <StringRegion<R> as Region>::ReadItem<'_>

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

fn reserve_regions<'a, I>(&mut self, regions: I)
where StringRegion<R>: 'a, I: Iterator<Item = &'a StringRegion<R>> + Clone,

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

fn clear(&mut self)

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

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

Heap size, size - capacity
Source§

fn reborrow<'b, 'a>( item: <StringRegion<R> as Region>::ReadItem<'a>, ) -> <StringRegion<R> as Region>::ReadItem<'b>
where 'a: 'b, StringRegion<R>: 'a,

Converts a read item into one with a narrower lifetime.
Source§

impl<'a, 'b, R> ReserveItems<&'a &'b str> for StringRegion<R>
where 'b: 'a, R: for<'c> Region<ReadItem<'c> = &'c [u8]> + for<'c> ReserveItems<&'c [u8]> + 'c,

Source§

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.
Source§

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

Source§

fn reserve_items<I>(&mut self, items: I)
where I: Iterator<Item = &'b String> + Clone,

Ensure that the region can absorb items without reallocation.
Source§

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

Source§

fn reserve_items<I>(&mut self, items: I)
where I: Iterator<Item = &'b str> + Clone,

Ensure that the region can absorb items without reallocation.
Source§

impl<R> Serialize for StringRegion<R>
where R: Serialize,

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<R> Freeze for StringRegion<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for StringRegion<R>
where R: RefUnwindSafe,

§

impl<R> Send for StringRegion<R>
where R: Send,

§

impl<R> Sync for StringRegion<R>
where R: Sync,

§

impl<R> Unpin for StringRegion<R>
where R: Unpin,

§

impl<R> UnwindSafe for StringRegion<R>
where R: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ProgressEventTimestamp for T
where T: Data + Debug + Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Upcasts this ProgressEventTimestamp to Any. Read more
Source§

fn type_name(&self) -> &'static str

Returns the name of the concrete type of this object. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Data for T
where T: Clone + 'static,

Source§

impl<T> Data for T
where T: Send + Sync + Any + Serialize + for<'a> Deserialize<'a> + 'static,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ExchangeData for T
where T: Data + Data,