Struct SeqStr 

pub struct SeqStr { /* private fields */ }

A sequence of &str, stored contiguously

This can be used as a drop-in replacement for Vec<String> in some cases, with better memory locality and fewer memory allocations.

When using SeqBytes instead of Vec<String>, the individual strings cannot be resized, but when this isn’t needed there isn’t much downside otherwise.

The container also supports “emplace”-style APIs like in_place_writer, which allow you to write the next element directly into the contiguous buffer with minimal overhead.

SeqStr::from_display_iter allows you to collect an iterator of impl Display items, formatting them directly into the contiguous buffer.

Implementations

impl SeqStr

pub fn new() -> Self

Create a new SeqStr

pub fn is_empty(&self) -> bool

Check if the sequence is empty

pub fn len(&self) -> usize

Get the number of str in the sequence

pub fn reserve(&mut self, extra: usize)

Reserve capacity for more str’s

pub fn shrink_to_fit(&mut self)

Shrink container to fit the current data

pub fn get(&self, idx: usize) -> Option<&str>

Get the i’th element of the sequence in a checked manner

pub fn get_mut(&mut self, idx: usize) -> Option<&mut str>

Get the i’th element of the sequence in a checked manner

pub fn contains(&self, s: impl AsRef<str>) -> bool

Check if the sequence contains a particular string

pub fn push(&mut self, s: impl AsRef<str>)

Push a &str onto the sequence

pub fn last(&self) -> Option<&str>

Get the last str of the sequence

pub fn pop(&mut self)

Pop the last element of the container Note that we can’t return it because of lifetimes, so call [last] before popping.

pub fn range( &self, range_bounds: impl RangeBounds<usize>, ) -> Map<SeqBytesIter<'_>, fn(&[u8]) -> &str>

Iterate over a range of the sequence of &str

This resembles std::collections::BTreeMap::range, and is needed becuase like BTreeMap, we can’t implement Deref or SliceIndex<Range> and produce a slice of our contents. See also [as_vec].

pub fn range_mut( &mut self, range_bounds: impl RangeBounds<usize>, ) -> Map<SeqBytesIterMut<'_>, fn(&mut [u8]) -> &mut str>

Iterate over a range of the sequence of &mut u8

pub fn iter(&self) -> Map<SeqBytesIter<'_>, fn(&[u8]) -> &str>

Iterate over the sequence of &str

pub fn iter_mut( &mut self, ) -> Map<SeqBytesIterMut<'_>, fn(&mut [u8]) -> &mut str>

Iterate over the sequence of &mut str

pub fn chunks( &self, chunk_size: usize, ) -> impl Clone + ExactSizeIterator<Item = impl Clone + ExactSizeIterator<Item = &str>>

Iterate over the sequence of &str, in chunks of given size. Returns an iterator which yields one iterator for each chunk, each of which yields chunk_size string values. The last chunk may be smaller.

pub fn truncate(&mut self, new_size: usize)

Truncate to at most the first n str

pub fn resize(&mut self, new_size: usize)

Resize to contain only the first n str, or pad up to n str, with empty str added

pub fn retain(&mut self, pred: impl FnMut(&str) -> bool)

Retain only those str satisfying a predicate. The str are always visited in order, similar to std::vec::Vec::retain.

pub fn retain_mut(&mut self, pred: impl FnMut(&mut str) -> bool)

Retain only those str satisfying a predicate. The str are always visited in order, similar to std::vec::Vec::retain_mut.

pub fn in_place_writer(&mut self) -> impl Write

Get an impl std::fmt::Write which can be used to write the next slice directly into the buffer without copying.

pub fn from_display_iter<T: Display, I: Iterator<Item = T>>(it: I) -> Self

Construct SeqStr from any items that implement Display, formatting them directly into the contiguous buffer.

pub fn as_vec(&self) -> Vec<&str>

Express as a Vec<&str>. The main reason that this may be useful is that there are useful methods on slice types &[&str], for example, [core::slice::binary_search], but SeqStr itself doesn’t implement Deref the way that Vec does and can only produce such a slice by allocating.

See SeqBytes::as_vec for more discussion of tradeoffs.

pub fn concat(&self) -> &str

Concatenate the str in the sequence into one string

pub fn join(&self, separator: &str) -> String

Join the str in the sequence into one string, placing a separator between them

Trait Implementations

impl Clone for SeqStr

fn clone(&self) -> SeqStr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SeqStr

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

Formats the value using the given formatter.

impl Default for SeqStr

fn default() -> SeqStr

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SeqStr

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SeqStr

impl<A: AsRef<str>> Extend<A> for SeqStr

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = A>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<A: AsRef<str>> FromIterator<A> for SeqStr

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = A>,

Creates a value from an iterator.

impl Hash for SeqStr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for SeqStr

type Output = str

The returned type after indexing.

fn index(&self, index: usize) -> &str

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for SeqStr

fn index_mut(&mut self, index: usize) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a SeqStr

type Item = &'a str

The type of the elements being iterated over.

type IntoIter = Map<SeqBytesIter<'a>, fn(&[u8]) -> &str>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for SeqStr

fn eq(&self, other: &SeqStr) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SeqStr

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SeqStr