Struct StringTape

pub struct StringTape<Offset: OffsetType = i32, A: Allocator = Global> { /* private fields */ }

UTF-8 string view over RawTape.

Implementations

impl<Offset: OffsetType, A: Allocator> StringTape<Offset, A>

pub fn new() -> StringTape<Offset, Global>

Creates a new, empty StringTape with the global allocator.

pub fn new_in(allocator: A) -> Self

Creates a new, empty StringTape with a custom allocator.

pub fn with_capacity( data_capacity: usize, strings_capacity: usize, ) -> Result<StringTape<Offset, Global>, StringTapeError>

Creates a new StringTape with pre-allocated capacity using the global allocator.

pub fn with_capacity_in( data_capacity: usize, strings_capacity: usize, allocator: A, ) -> Result<Self, StringTapeError>

Creates a new StringTape with pre-allocated capacity and a custom allocator.

pub fn push(&mut self, s: &str) -> Result<(), StringTapeError>

Adds a string to the end of the StringTape.

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

Returns a reference to the string at the given index, or None if out of bounds.

pub fn len(&self) -> usize

Returns the number of strings in the StringTape.

pub fn is_empty(&self) -> bool

Returns true if the StringTape contains no strings.

pub fn data_len(&self) -> usize

Returns the total number of bytes used by string data.

pub fn capacity(&self) -> usize

Returns the number of strings currently stored (same as len()).

pub fn data_capacity(&self) -> usize

Returns the number of bytes allocated for string data.

pub fn clear(&mut self)

Removes all strings from the StringTape, keeping allocated capacity.

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

Shortens the StringTape, keeping the first len strings and dropping the rest.

pub fn extend<I>(&mut self, iter: I) -> Result<(), StringTapeError>

where I: IntoIterator, I::Item: AsRef<str>,

Extends the StringTape with the contents of an iterator.

pub fn as_raw_parts(&self) -> (*const u8, *const Offset, usize, usize)

Returns the raw parts of the StringTape for Apache Arrow compatibility.

pub fn iter(&self) -> StringTapeIter<'_, Offset, A>

pub fn allocator(&self) -> &A

Returns a reference to the allocator used by this StringTape.

Trait Implementations

impl<Offset: OffsetType> Default for StringTape<Offset, Global>

fn default() -> Self

Returns the “default value” for a type.

impl<Offset: OffsetType, A: Allocator> Drop for StringTape<Offset, A>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, Offset: OffsetType> FromIterator<&'a str> for StringTape<Offset, Global>

fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self

Creates a value from an iterator.

impl<Offset: OffsetType> FromIterator<String> for StringTape<Offset, Global>

fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> Self

Creates a value from an iterator.

impl<Offset: OffsetType, A: Allocator> Index<usize> for StringTape<Offset, A>

type Output = str

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, Offset: OffsetType, A: Allocator> IntoIterator for &'a StringTape<Offset, A>

type Item = &'a str

The type of the elements being iterated over.

type IntoIter = StringTapeIter<'a, Offset, A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Offset: OffsetType + Send, A: Allocator + Send> Send for StringTape<Offset, A>

impl<Offset: OffsetType + Sync, A: Allocator + Sync> Sync for StringTape<Offset, A>