Skip to main content

IterStringData

Struct IterStringData 

Source
pub struct IterStringData<I>
where I: Iterator<Item = String>,
{ state: IterState<I, String>, }
Expand description

Iterator-backed string vector data adaptor.

Wraps an iterator producing String values and implements the data-level traits (AltrepLen + AltStringData) for backing an ALTREP character vector. To expose it to R, wrap it in a #[derive(AltrepString)] + #[altrep(manual)] struct (see the module docs).

§Performance Warning

Unlike other Iter*Data types, accessing ANY element forces full materialization of the entire iterator. This is because R’s AltStringData::elt() returns a borrowed &str, which requires stable storage. The internal RefCell cannot provide the required lifetime, so all strings must be materialized upfront.

This means:

  • elt(0) on a million-element iterator will generate ALL million strings
  • There is no lazy evaluation benefit for string iterators
  • Memory usage equals the full vector regardless of access patterns

For truly lazy string ALTREP, consider implementing a custom type that stores strings in a way that allows borrowing without full materialization (e.g., arena allocation or caching generated strings incrementally).

§Example

use miniextendr_api::altrep_data::IterStringData;

let iter = (0..5).map(|x| format!("item_{}", x));
let data = IterStringData::from_iter(iter, 5);
// First access to ANY element will materialize all 5 strings

Fields§

§state: IterState<I, String>

Implementations§

Source§

impl<I> IterStringData<I>
where I: Iterator<Item = String>,

Source

pub fn from_iter(iter: I, len: usize) -> Self

Create from an iterator with explicit length.

Source§

impl<I> IterStringData<I>
where I: ExactSizeIterator<Item = String>,

Source

pub fn from_exact_iter(iter: I) -> Self

Create from an ExactSizeIterator (length auto-detected).

Trait Implementations§

Source§

impl<I> AltStringData for IterStringData<I>
where I: Iterator<Item = String>,

Source§

fn elt(&self, i: usize) -> Option<&str>

Get the string element at index i. Read more
Source§

fn is_sorted(&self) -> Option<Sortedness>

Optional: sortedness hint.
Source§

fn no_na(&self) -> Option<bool>

Optional: does this vector contain any NA values?
Source§

impl<I> AltrepLen for IterStringData<I>
where I: Iterator<Item = String>,

Source§

fn len(&self) -> usize

Returns the length of this ALTREP vector.
Source§

fn is_empty(&self) -> bool

Returns true if the vector is empty.

Auto Trait Implementations§

§

impl<I> !Freeze for IterStringData<I>

§

impl<I> !RefUnwindSafe for IterStringData<I>

§

impl<I> !Sync for IterStringData<I>

§

impl<I> Send for IterStringData<I>
where I: Send,

§

impl<I> Unpin for IterStringData<I>
where I: Unpin,

§

impl<I> UnsafeUnpin for IterStringData<I>
where I: UnsafeUnpin,

§

impl<I> UnwindSafe for IterStringData<I>
where I: 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> 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> SizeHint for T
where T: ?Sized,

Source§

default fn lower_bound(&self) -> usize

🔬This is a nightly-only experimental API. (core_io_internals)
Returns a lower bound on the number of elements this container-like item contains. For example, an array [u8; 12] could return any value between 0 and 12 inclusively as a correct implementation. Read more
Source§

default fn upper_bound(&self) -> Option<usize>

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an upper bound on the number of elements this container-like item contains if it can be determined, otherwise None. Read more
Source§

final fn size_hint(&self) -> (usize, Option<usize>)

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an estimate for the number of elements this container like type contains. Read more
Source§

impl<T> SizedTypeProperties for T

Source§

#[doc(hidden)]
const SIZE: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGNMENT: Alignment = _

🔬This is a nightly-only experimental API. (ptr_alignment_type)
Source§

#[doc(hidden)]
const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)]
const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const MAX_SLICE_LEN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
The largest safe length for a [Self]. 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.

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.