Skip to main content

StrListRef

Struct StrListRef 

Source
pub struct StrListRef<'a> { /* private fields */ }
Expand description

A borrowed, read-only view over string list data.

StrListRef borrows &[u8] (data) and &[u32] (boundary table) and provides the same read-only API as StrList. Use it for zero-copy views over external buffers (e.g., memory-mapped files).

§Invariants

Same as StrList: data is valid UTF-8 and ends are valid boundaries. When constructed via new, these invariants are validated. When constructed via From<&StrStack> or From<&StrList>, they are inherited.

Implementations§

Source§

impl<'a> StrListRef<'a>

Source

pub fn new( data: &'a [u8], ends: &'a [u32], ) -> Result<Self, StrListValidationError>

Creates a StrListRef from raw data and boundary slices, validating UTF-8 and boundary consistency.

Validation checks (O(total bytes)):

  • ends values are monotonically non-decreasing
  • Last value does not exceed data.len()
  • Each segment data[ends[i-1]..ends[i]] (with ends[-1] = 0) is valid UTF-8
Source

pub fn len(&self) -> usize

Returns the number of string segments.

Source

pub fn is_empty(&self) -> bool

Returns true if the list contains no segments.

Source

pub fn bytes_len(&self) -> u32

Returns the total byte length of the data buffer.

Source

pub fn as_str(&self) -> &'a str

Returns the concatenation of all segments as a single &str.

Source

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

Returns the segment at index, or None if out of bounds.

Source

pub fn get_bounds(&self, index: usize) -> Option<(u32, u32)>

Returns the byte offset bounds (start, end) for the segment at index.

Source

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

Returns the last segment, or None if empty.

Source

pub fn iter(&self) -> StrListIter<'a>

Returns an iterator over the string segments.

Trait Implementations§

Source§

impl<'a> Clone for StrListRef<'a>

Source§

fn clone(&self) -> StrListRef<'a>

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> Debug for StrListRef<'a>

Source§

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

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

impl<'a> From<&'a StrList> for StrListRef<'a>

Source§

fn from(list: &'a StrList) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<&'a StrStack> for StrListRef<'a>

Source§

fn from(stack: &'a StrStack) -> Self

Converts to this type from the input type.
Source§

impl<'a> IntoIterator for StrListRef<'a>

Source§

type Item = &'a str

The type of the elements being iterated over.
Source§

type IntoIter = StrListIter<'a>

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> PartialEq for StrListRef<'a>

Source§

fn eq(&self, other: &StrListRef<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'a> Copy for StrListRef<'a>

Source§

impl<'a> Eq for StrListRef<'a>

Source§

impl<'a> StructuralPartialEq for StrListRef<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for StrListRef<'a>

§

impl<'a> RefUnwindSafe for StrListRef<'a>

§

impl<'a> Send for StrListRef<'a>

§

impl<'a> Sync for StrListRef<'a>

§

impl<'a> Unpin for StrListRef<'a>

§

impl<'a> UnsafeUnpin for StrListRef<'a>

§

impl<'a> UnwindSafe for StrListRef<'a>

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.