Struct BytesTape 

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

Binary bytes view over RawTape.

Implementations

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

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

Creates a new, empty BytesTape with the global allocator.

pub fn new_in(allocator: A) -> Self

Creates a new, empty BytesTape with a custom allocator.

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

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

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

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

pub fn push(&mut self, bytes: &[u8]) -> Result<(), StringTapeError>

Adds bytes to the end of the tape.

pub fn get(&self, index: usize) -> Option<&[u8]>

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

pub unsafe fn get_unchecked(&self, index: usize) -> &[u8]

Returns a reference to the bytes at the given index without bounds checking.

Safety

Caller must ensure index < self.len().

pub fn len(&self) -> usize

Returns the number of items in the tape.

pub fn is_empty(&self) -> bool

Returns true if the tape contains no items.

pub fn data_len(&self) -> usize

Returns the total number of bytes used by data.

pub fn data_capacity(&self) -> usize

Returns the number of bytes allocated for data.

pub fn offsets_capacity(&self) -> usize

Returns the number of offset slots allocated.

pub fn clear(&mut self)

Removes all items from the tape, keeping allocated capacity.

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

Shortens the tape, keeping the first len items and dropping the rest.

pub fn first(&self) -> Option<&[u8]>

Returns a reference to the first item, or None if empty.

pub fn last(&self) -> Option<&[u8]>

Returns a reference to the last item, or None if empty.

pub fn pop(&mut self) -> Option<()>

Removes and returns the last item, or None if empty.

pub fn contains(&self, item: &[u8]) -> bool

Returns true if the tape contains the given byte slice.

pub fn shrink_to_fit(&mut self) -> Result<(), StringTapeError>

Shrinks allocated capacity to fit current data.

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

where I: IntoIterator, I::Item: AsRef<[u8]>,

Extends the tape with the contents of an iterator of bytes.

pub fn as_raw_parts(&self) -> RawParts<Offset>

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

pub fn data_slice(&self) -> &[u8]

Returns a slice view of the data buffer.

pub fn offsets_slice(&self) -> &[Offset]

Returns a slice view of the offsets buffer.

pub fn allocator(&self) -> &A

Returns a reference to the allocator used by this BytesTape.

pub fn view(&self) -> BytesTapeView<'_, Offset>

Creates a view of the entire BytesTape.

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

Returns an iterator over the byte cows.

pub fn subview( &self, start: usize, end: usize, ) -> Result<BytesTapeView<'_, Offset>, StringTapeError>

Creates a subview of a continuous slice of this BytesTape.

pub fn as_reorderable<Length: LengthType>( &self, ) -> Result<BytesCows<'_, Offset, Length>, StringTapeError>

Creates a BytesCows view of the tape.

Example

let mut tape = BytesTapeI32::new();
tape.push(&[1, 2, 3])?;
tape.push(&[4, 5, 6])?;
tape.push(&[7, 8, 9])?;

let cows: BytesCows<i32, u16> = tape.as_reorderable()?;
assert_eq!(cows.get(0), Some(&[1, 2, 3][..]));

pub fn arrow_slices(&self) -> (&[u8], &[Offset])

Returns data and offsets slices for zero-copy Arrow conversion.

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

pub fn try_into_chars_tape( self, ) -> Result<CharsTape<Offset, A>, StringTapeError>

Trait Implementations

impl<Offset: OffsetType, A: Allocator + Clone> Clone for BytesTape<Offset, A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Offset: OffsetType, A: Allocator> Debug for BytesTape<Offset, A>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<'a, Offset: OffsetType, A: Allocator> Extend<&'a [u8]> for BytesTape<Offset, A>

fn extend<I: IntoIterator<Item = &'a [u8]>>(&mut self, iter: I)

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<Offset: OffsetType, A: Allocator> From<CharsTape<Offset, A>> for BytesTape<Offset, A>

fn from(chars_tape: CharsTape<Offset, A>) -> Self

Converts to this type from the input type.

impl<'a, Offset: OffsetType> FromIterator<&'a [u8]> for BytesTape<Offset, Global>

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

Creates a value from an iterator.

impl<Offset: OffsetType> FromIterator<Vec<u8>> for BytesTape<Offset, Global>

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

Creates a value from an iterator.

impl<Offset: OffsetType, A: Allocator> Hash for BytesTape<Offset, A>

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<Offset: OffsetType, A: Allocator> Index<usize> for BytesTape<Offset, A>

type Output = [u8]

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 BytesTape<Offset, A>

type Item = &'a [u8]

The type of the elements being iterated over.

type IntoIter = BytesTapeIter<'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, A: Allocator> Ord for BytesTape<Offset, A>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Offset: OffsetType, A: Allocator> PartialEq for BytesTape<Offset, A>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Offset: OffsetType, A: Allocator> PartialOrd for BytesTape<Offset, A>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Offset: OffsetType, A: Allocator> TryFrom<BytesTape<Offset, A>> for CharsTape<Offset, A>

type Error = StringTapeError

The type returned in the event of a conversion error.

fn try_from(bytes_tape: BytesTape<Offset, A>) -> Result<Self, Self::Error>

Performs the conversion.

impl<Offset: OffsetType, A: Allocator> Eq for BytesTape<Offset, A>

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

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