BytesCows

Struct BytesCows 

Source
pub struct BytesCows<'a, Offset: OffsetType = u32, Length: LengthType = u16> { /* private fields */ }
Expand description

A memory-efficient collection of byte slices with configurable offset and length types.

Similar to CharsCows but for arbitrary binary data without UTF-8 validation.

Implementations§

Source§

impl<'a, Offset: OffsetType, Length: LengthType> BytesCows<'a, Offset, Length>

Source

pub fn from_iter_and_data<I>( iter: I, data: Cow<'a, [u8]>, ) -> Result<Self, StringTapeError>
where I: IntoIterator, I::Item: AsRef<[u8]>,

Creates BytesCows from iterator of byte slices and shared data buffer.

Slices must be subslices of the data buffer. Offsets and lengths are inferred from slice pointers.

Source

pub fn from_offsets_and_data<I>( iter: I, data: Cow<'a, [u8]>, ) -> Result<Self, StringTapeError>
where I: IntoIterator<Item = (usize, usize)>,

Creates BytesCows from iterator of (offset, length) pairs and data buffer.

Source

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

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

Source

pub fn len(&self) -> usize

Returns the number of slices in the collection.

Source

pub fn is_empty(&self) -> bool

Returns true if the collection contains no cows.

Source

pub fn iter(&self) -> BytesCowsIter<'_, Offset, Length>

Returns an iterator over the byte cows.

Source

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

Returns a reference to the underlying data buffer.

Source

pub fn as_chars(&self) -> Result<CharsCows<'_, Offset, Length>, StringTapeError>

Returns a zero-copy view of this BytesCows as a CharsCows if all slices are valid UTF-8.

This validates that all byte slices contain valid UTF-8, then reinterprets the collection as strings without copying or moving any data.

§Errors

Returns StringTapeError::Utf8Error if any slice contains invalid UTF-8.

§Examples
use stringtape::BytesCowsU32U8;
use std::borrow::Cow;

let data = b"hello world";
let bytes = BytesCowsU32U8::from_iter_and_data(
    data.split(|&b| b == b' '),
    Cow::Borrowed(&data[..])
).unwrap();

let chars = bytes.as_chars().unwrap();
assert_eq!(chars.get(0), Some("hello"));
assert_eq!(chars.get(1), Some("world"));
Source§

impl<'a, Offset: OffsetType, Length: LengthType> BytesCows<'a, Offset, Length>

Source

pub fn try_into_chars_slices( self, ) -> Result<CharsCows<'a, Offset, Length>, StringTapeError>

Trait Implementations§

Source§

impl<'a, Offset: Clone + OffsetType, Length: Clone + LengthType> Clone for BytesCows<'a, Offset, Length>

Source§

fn clone(&self) -> BytesCows<'a, Offset, Length>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, Offset: Debug + OffsetType, Length: Debug + LengthType> Debug for BytesCows<'a, Offset, Length>

Source§

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

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

impl<'a, Offset: OffsetType, Length: LengthType> From<CharsCows<'a, Offset, Length>> for BytesCows<'a, Offset, Length>

Source§

fn from(chars_slices: CharsCows<'a, Offset, Length>) -> Self

Converts to this type from the input type.
Source§

impl<'a, Offset: OffsetType, Length: LengthType> Index<usize> for BytesCows<'a, Offset, Length>

Source§

type Output = [u8]

The returned type after indexing.
Source§

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

Performs the indexing (container[index]) operation. Read more
Source§

impl<'a, Offset: OffsetType, Length: LengthType> IntoIterator for &'a BytesCows<'a, Offset, Length>

Source§

type Item = &'a [u8]

The type of the elements being iterated over.
Source§

type IntoIter = BytesCowsIter<'a, Offset, Length>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a, Offset: OffsetType, Length: LengthType> TryFrom<BytesCows<'a, Offset, Length>> for CharsCows<'a, Offset, Length>

Source§

type Error = StringTapeError

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

fn try_from( bytes_slices: BytesCows<'a, Offset, Length>, ) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl<'a, Offset, Length> Freeze for BytesCows<'a, Offset, Length>

§

impl<'a, Offset, Length> RefUnwindSafe for BytesCows<'a, Offset, Length>
where Offset: RefUnwindSafe, Length: RefUnwindSafe,

§

impl<'a, Offset, Length> Send for BytesCows<'a, Offset, Length>
where Offset: Send, Length: Send,

§

impl<'a, Offset, Length> Sync for BytesCows<'a, Offset, Length>
where Offset: Sync, Length: Sync,

§

impl<'a, Offset, Length> Unpin for BytesCows<'a, Offset, Length>
where Offset: Unpin, Length: Unpin,

§

impl<'a, Offset, Length> UnwindSafe for BytesCows<'a, Offset, Length>
where Offset: UnwindSafe, Length: 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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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.