Struct ReadPlan 

pub struct ReadPlan { /* private fields */ }

Implementations

impl ReadPlan

pub fn input(source: usize, items: usize) -> Self

pub fn fill(items: usize) -> Self

pub fn index(base: i64, step: i64, items: usize) -> Self

pub fn copy( source: usize, source_items: usize, map: Mapping, items: usize, missing: Missing, ) -> Self

pub fn joined( rows: usize, parts: impl IntoIterator<Item = Self>, ) -> Result<Self, Error>

The read of parts side by side in rows rows, as a catenate reads its arguments: each row holds each part’s next stretch of its items in turn, an equal share of the part’s items.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn route(&self) -> &ReadRoute

pub fn at(&self, item: usize) -> Run

What item item reads, as a one-item run (runs), or Run::Invalid past the end.

pub fn runs(&self, range: Range<usize>, sink: &mut dyn RunSink) -> bool

Gives sink the runs of items range, in order, until it stops, and whether it took every run. A source gives a run of its items, an index plan a run of values, a default fills, and a join each part’s stretch of each row. A map gives the runs of its positions (Mapping::spans), each read through its input, and its misses through its plan of misses, unless the sink walks it whole (RunSink::walk). Only a strided run through a map reads one position at a time.

pub fn mapped( input: ReadPlan, map: Mapping, missing: ReadPlan, items: usize, ) -> Self

pub fn remapped(&self, map: Mapping, items: usize, missing: Missing) -> Self

pub fn try_for_each_source<E>( &self, visit: &mut impl FnMut(usize, usize) -> Result<(), E>, ) -> Result<(), E>

Calls visit with each source that this read reaches and its item count. A plan’s routes form a tree, so each place that reads a source visits it once.

pub fn as_codes(&self, character: bool) -> Cow<'_, Self>

Preserve a logical character read’s space default while its bindings become integer codepoints.

pub fn contiguous(&self, range: Range<usize>) -> Option<(usize, Range<usize>)>

pub fn shape_hint(&self) -> Vec<usize>

pub fn positional(&self, shape: &[usize]) -> Option<(usize, Mapping)>

The one source that a read over a result of shape reaches by an affine map, and that map, where every position stays within the source. None for a read that joins sources, fills, or maps otherwise.

pub fn affine(&self, shape: &[usize]) -> Option<(usize, usize, Vec<isize>)>

One source’s affine view. Missing positions and non-affine compositions have no borrowed export.

pub fn inverse( &self, source: usize, shape: &[usize], items: usize, ) -> Option<Mapping>

The inverse read where this plan visits every item of one source once by affine axes.

Trait Implementations

impl Clone for ReadPlan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadPlan

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

Formats the value using the given formatter.

impl Eq for ReadPlan

impl PartialEq for ReadPlan

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadPlan