Struct VectoredByteSlices

pub struct VectoredByteSlices<'string, 'slice>(/* private fields */);

Available on crate feature vectored only.

A slice of ByteSlice.

This struct wraps non-contiguous slices of string data to pass to the scan_sync_vectored() search method, which produces match results of type VectoredMatch pointing to a subset of the original data.

This is currently implemented as a #[repr(transparent)] wrapper over &'slice [ByteSlice<'string>].

Implementations

impl<'string, 'slice> VectoredByteSlices<'string, 'slice>

Byte-Oriented Interface

Because vectorscan only partially supports vectored string inputs, this library does not attempt to provide a UTF8-encoded str interface for vectored strings as with ByteSlice.

However, From implementations are still provided to convert from references to arrays and slices:

 use vectorscan::sources::VectoredByteSlices;

 let b1 = b"asdf";
 let b2 = b"bbbb";
 let bb = [b1.into(), b2.into()];
 let bs = VectoredByteSlices::from_slices(&bb);
 let bb2 = [b1.as_ref(), b2.as_ref()];
 let bs2: VectoredByteSlices = bb2.as_ref().into();
 assert_eq!(bs, bs2);

pub const fn from_slices(data: &'slice [ByteSlice<'string>]) -> Self

Wrap a slice of byte slices so they can be scanned in vectored mode.

Like ByteSlice::from_slice(), this method is const so it can be used in const values and static initializers.

pub fn length_sum(&self) -> usize

Return the sum of all lengths of all slices.

impl<'string, 'slice> VectoredByteSlices<'string, 'slice>

Ownership and Indexing

Keeping track of a subset of vectored strings requires some more work than for ByteSlice, since a subset of vectored data may start or stop in the middle of a particular slice. As a result, Self::index_range() cannot simply return Self and return a reference to itself without allocating new memory the way ByteSlice::index_range() can.

However, it is possible to avoid dynamic memory allocation when extracting subsets of vectored data; instead, Self::index_range() returns VectoredSubset, which tracks offsets within the vectored string data without additional allocations.

pub fn index_range( &self, range: Range<usize>, ) -> Option<VectoredSubset<'string, 'slice>>

Return a subset of the input, or None if the result would be out of range:

 use vectorscan::sources::VectoredByteSlices;

 let b1 = "asdf";
 let b2 = "ok";
 let b3 = "bsdf";
 let bb = [b1.into(), b2.into(), b3.into()];
 let bs = VectoredByteSlices::from_slices(&bb);

 let sub = bs.index_range(2..8).unwrap();
 let collected: Vec<&str> = sub.iter_slices().map(|s| unsafe { s.as_str() }).collect();
 assert_eq!(&collected, &["df", "ok", "bs"]);

This method is largely intended for internal use inside this library, but is exposed in the public API to make it clear how the match callback converts match offsets to substrings of the original input data.

pub fn as_slices(&self) -> &'slice [ByteSlice<'string>]

Iterate over all of the original vectored data.

This is the corollary to VectoredSubset::iter_slices() and is mainly intended to aid in debugging.

 use vectorscan::sources::VectoredByteSlices;

 let b1 = "asdf";
 let b2 = "ok";
 let b3 = "bbbb";
 let bb = [b1.into(), b2.into(), b3.into()];
 let bs = VectoredByteSlices::from_slices(&bb);

 let collected: Vec<&str> = bs.as_slices().iter().map(|s| unsafe { s.as_str() }).collect();
 assert_eq!(&collected, &["asdf", "ok", "bbbb"]);

Trait Implementations

impl<'string, 'slice> Clone for VectoredByteSlices<'string, 'slice>

fn clone(&self) -> VectoredByteSlices<'string, 'slice>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'string, 'slice> Debug for VectoredByteSlices<'string, 'slice>

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

Formats the value using the given formatter.

impl<'string, 'slice> From<&'slice [&'string [u8]]> for VectoredByteSlices<'string, 'slice>

fn from(x: &'slice [&'string [u8]]) -> Self

Converts to this type from the input type.

impl<'string, 'slice, const N: usize> From<&'slice [&'string [u8]; N]> for VectoredByteSlices<'string, 'slice>

fn from(x: &'slice [&'string [u8]; N]) -> Self

Converts to this type from the input type.

impl<'string, 'slice> From<&'slice [ByteSlice<'string>]> for VectoredByteSlices<'string, 'slice>

fn from(x: &'slice [ByteSlice<'string>]) -> Self

Converts to this type from the input type.

impl<'string, 'slice, const N: usize> From<&'slice [ByteSlice<'string>; N]> for VectoredByteSlices<'string, 'slice>

fn from(x: &'slice [ByteSlice<'string>; N]) -> Self

Converts to this type from the input type.

impl<'string, 'slice> Hash for VectoredByteSlices<'string, 'slice>

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<'string, 'slice> Ord for VectoredByteSlices<'string, 'slice>

fn cmp(&self, other: &VectoredByteSlices<'string, 'slice>) -> 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<'string, 'slice> PartialEq for VectoredByteSlices<'string, 'slice>

fn eq(&self, other: &VectoredByteSlices<'string, 'slice>) -> 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<'string, 'slice> PartialOrd for VectoredByteSlices<'string, 'slice>

fn partial_cmp( &self, other: &VectoredByteSlices<'string, 'slice>, ) -> 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<'string, 'slice> Copy for VectoredByteSlices<'string, 'slice>

impl<'string, 'slice> Eq for VectoredByteSlices<'string, 'slice>

impl<'string, 'slice> StructuralPartialEq for VectoredByteSlices<'string, 'slice>