Skip to main content

IterListData

Struct IterListData 

Source
pub struct IterListData<I: Iterator<Item = SEXP>> {
    len: usize,
    iter: RefCell<Option<I>>,
    cached: Cell<usize>,
    cache: OnceCell<PoolRoot>,
}
Expand description

Iterator-backed list data with a rooted cache of the yielded R objects.

Construction does not advance the iterator or allocate R storage. The first in-bounds read allocates one list of the declared length, and each yielded object goes into it before the next call to Iterator::next. So the iterator can return fresh, unprotected objects, as in (0..n).map(|i| vec![i].into_sexp()). It remains responsible for rooting any R objects it keeps between calls.

The cache list is rooted in the same pool as owning ExternalPtr handles. The adapter roots it itself, so it is safe before it is attached to an ALTREP object, and releases it on drop. That pool releases in O(1) in any order: R’s finalizers drop ALTREP owners newest first, whatever order their caches were created in.

Reads generate only the requested prefix. Elements past the end of a short source read as R NULL; the source is dropped on its first None and never resumed. An infinite source is consumed only up to the declared length.

Clone copies the cache list, sharing its elements as R’s shallow_duplicate() does, and clones the remaining iterator without advancing it. Serialization realizes the declared prefix, NULLs included, and restoration needs no I. Delegate these data traits from a concrete #[derive(AltrepList)] class with #[altrep(manual, serialize, duplicate = "clone")].

The adapter is !Send + !Sync: build, read, clone and drop it on R’s main thread.

ⓘ
use miniextendr_api::{IntoR, altrep_data::IterListData};
let data = IterListData::from_exact_iter((0..5).map(|x| vec![x, x + 1].into_sexp()));

Fields§

§len: usize§iter: RefCell<Option<I>>§cached: Cell<usize>§cache: OnceCell<PoolRoot>

Implementations§

Source§

impl<I: Iterator<Item = SEXP>> IterListData<I>

Source

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

Create a lazy adapter for exactly the declared prefix.

Source

fn cache(&self) -> SEXP

Source§

impl<I: ExactSizeIterator<Item = SEXP>> IterListData<I>

Source

pub fn from_exact_iter(iter: I) -> Self

Create a lazy adapter using the iterator’s remaining length.

Trait Implementations§

Source§

impl<I: Iterator<Item = SEXP>> AltListData for IterListData<I>

Source§

fn elt(&self, i: usize) -> SEXP

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

impl<I: Iterator<Item = SEXP>> AltrepLen for IterListData<I>

Source§

fn altrep_len(&self) -> usize

Returns the length of this ALTREP vector.
Source§

fn altrep_is_empty(&self) -> bool

Returns true if the vector is empty.
Source§

impl<I: Iterator<Item = SEXP>> AltrepSerialize for IterListData<I>

Source§

fn serialized_state(&self) -> SEXP

Convert the ALTREP data to a serializable R object.
Source§

fn unserialize(state: SEXP) -> Option<Self>

Reconstruct the ALTREP data from a serialized state. Read more
Source§

impl<I: Iterator<Item = SEXP> + Clone> Clone for IterListData<I>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<I> !Freeze for IterListData<I>

§

impl<I> !RefUnwindSafe for IterListData<I>

§

impl<I> !Send for IterListData<I>

§

impl<I> !Sync for IterListData<I>

§

impl<I> Unpin for IterListData<I>
where RefCell<Option<I>>: Unpin,

§

impl<I> UnsafeUnpin for IterListData<I>

§

impl<I> UnwindSafe for IterListData<I>

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> ConsumingFallible for T
where T: Clone,

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> RClone for T
where T: Clone,

Source§

fn r_clone(&self) -> T

Create a deep copy of this value.
Source§

#[doc(hidden)]
unsafe extern "C" fn __RClone_r_clone_shim( data: *mut c_void, argc: i32, argv: *const SEXP, ) -> SEXP
where Self: Sized + RClone + IntoR,

Method shim for RClone::r_clone. Read more
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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.