CharsCowsAuto

Enum CharsCowsAuto 

Source
pub enum CharsCowsAuto<'a> {
    U32U8(CharsCows<'a, u32, u8>),
    U32U16(CharsCows<'a, u32, u16>),
    U32U32(CharsCows<'a, u32, u32>),
    U64U8(CharsCows<'a, u64, u8>),
    U64U16(CharsCows<'a, u64, u16>),
    U64U32(CharsCows<'a, u64, u32>),
}
Expand description

Automatically selects the most memory-efficient CharsCows type based on data size.

Returns an enum that can hold any combination of offset/length types.

Variants§

§

U32U8(CharsCows<'a, u32, u8>)

§

U32U16(CharsCows<'a, u32, u16>)

§

U32U32(CharsCows<'a, u32, u32>)

§

U64U8(CharsCows<'a, u64, u8>)

§

U64U16(CharsCows<'a, u64, u16>)

§

U64U32(CharsCows<'a, u64, u32>)

Implementations§

Source§

impl<'a> CharsCowsAuto<'a>

Source

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

Creates the most memory-efficient CharsCows based on data size and max word length.

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

let data = "hello world";
let cows = CharsCowsAuto::from_iter_and_data(
    data.split_whitespace(),
    Cow::Borrowed(data.as_bytes())
).unwrap();

// Automatically picks CharsCows<u32, u8> for small data
assert_eq!(cows.len(), 2);

Creates the most memory-efficient CharsCows using a two-pass strategy.

First pass scans to find the maximum word length, then second pass builds with optimal types. Requires Clone iterator for memory efficiency.

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

let data = "hello world";
let cows = CharsCowsAuto::from_iter_and_data(
    data.split_whitespace(),  // Clone iterator
    Cow::Borrowed(data.as_bytes())
).unwrap();

assert_eq!(cows.len(), 2);
Source

pub fn len(&self) -> usize

Returns the number of cows.

Source

pub fn is_empty(&self) -> bool

Returns true if the collection contains no cows.

Source

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

Returns a reference to the string at the given index.

Source

pub fn bytes_per_entry(&self) -> usize

Returns the byte size per entry for the selected type combination.

Source

pub fn type_name(&self) -> &'static str

Returns a string describing the selected type combination.

Source

pub fn iter(&self) -> CharsCowsAutoIter<'_>

Returns an iterator over the string cows.

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

let data = "hello world foo";
let cows = CharsCowsAuto::from_iter_and_data(
    data.split_whitespace(),
    Cow::Borrowed(data.as_bytes())
).unwrap();

let words: Vec<&str> = cows.iter().collect();
assert_eq!(words, vec!["hello", "world", "foo"]);
Source

pub fn sort(&mut self)

Sorts the slices in-place using the default string comparison.

This is a stable sort that preserves the order of equal elements.

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

let data = "zebra apple banana";
let mut cows = CharsCowsAuto::from_iter_and_data(
    data.split_whitespace(),
    Cow::Borrowed(data.as_bytes())
).unwrap();

cows.sort();
let sorted: Vec<&str> = cows.iter().collect();
assert_eq!(sorted, vec!["apple", "banana", "zebra"]);
Source

pub fn sort_unstable(&mut self)

Sorts the slices in-place using an unstable sorting algorithm.

This is faster than stable sort but may not preserve the order of equal elements.

Source

pub fn sort_by<F>(&mut self, compare: F)
where F: FnMut(&str, &str) -> Ordering,

Sorts the slices in-place using a custom comparison function.

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

let data = "aaa bb c";
let mut cows = CharsCowsAuto::from_iter_and_data(
    data.split_whitespace(),
    Cow::Borrowed(data.as_bytes())
).unwrap();

// Sort by length, then alphabetically
cows.sort_by(|a, b| a.len().cmp(&b.len()).then(a.cmp(b)));
let sorted: Vec<&str> = cows.iter().collect();
assert_eq!(sorted, vec!["c", "bb", "aaa"]);
Source

pub fn sort_by_key<K, F>(&mut self, f: F)
where F: FnMut(&str) -> K, K: Ord,

Sorts the slices in-place using a key extraction function.

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

let data = "aaa bb c";
let mut cows = CharsCowsAuto::from_iter_and_data(
    data.split_whitespace(),
    Cow::Borrowed(data.as_bytes())
).unwrap();

// Sort by string length
cows.sort_by_key(|s| s.len());
let sorted: Vec<&str> = cows.iter().collect();
assert_eq!(sorted, vec!["c", "bb", "aaa"]);
Source

pub fn as_bytes(&self) -> BytesCowsAuto<'_>

Returns a zero-copy view of this CharsCowsAuto as a BytesCowsAuto.

This is a no-cost operation that reinterprets the string collection as bytes without copying or moving any data.

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

let data = "hello world";
let cows = CharsCowsAuto::from_iter_and_data(
    data.split_whitespace(),
    Cow::Borrowed(data.as_bytes())
).unwrap();

let bytes = cows.as_bytes();
assert_eq!(bytes.get(0), Some(&b"hello"[..]));
assert_eq!(bytes.get(1), Some(&b"world"[..]));

Trait Implementations§

Source§

impl<'a> IntoIterator for &'a CharsCowsAuto<'a>

Source§

type Item = &'a str

The type of the elements being iterated over.
Source§

type IntoIter = CharsCowsAutoIter<'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

Auto Trait Implementations§

§

impl<'a> Freeze for CharsCowsAuto<'a>

§

impl<'a> RefUnwindSafe for CharsCowsAuto<'a>

§

impl<'a> Send for CharsCowsAuto<'a>

§

impl<'a> Sync for CharsCowsAuto<'a>

§

impl<'a> Unpin for CharsCowsAuto<'a>

§

impl<'a> UnwindSafe for CharsCowsAuto<'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> 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, 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.