Struct NippyJarCursor

pub struct NippyJarCursor<'a, H = ()> { /* private fields */ }

Simple cursor implementation to retrieve data from NippyJar.

Implementations

impl<'a, H: NippyJarHeader> NippyJarCursor<'a, H>

pub fn new(jar: &'a NippyJar<H>) -> Result<Self, NippyJarError>

Creates a new instance of NippyJarCursor for the given NippyJar.

pub fn with_reader( jar: &'a NippyJar<H>, reader: Arc<DataReader>, ) -> Result<Self, NippyJarError>

Creates a new instance of NippyJarCursor with the specified NippyJar and data reader.

pub const fn jar(&self) -> &NippyJar<H>

Returns a reference to the related NippyJar

pub const fn row_index(&self) -> u64

Returns current row index of the cursor

pub fn reset(&mut self)

Resets cursor to the beginning.

pub fn row_by_number( &mut self, row: usize, ) -> Result<Option<Vec<&'_ [u8]>>, NippyJarError>

Returns a row by its number.

pub fn next_row(&mut self) -> Result<Option<Vec<&'_ [u8]>>, NippyJarError>

Returns the current value and advances the row.

pub fn row_by_number_with_cols( &mut self, row: usize, mask: usize, ) -> Result<Option<Vec<&'_ [u8]>>, NippyJarError>

Returns a row by its number by using a mask to only read certain columns from the row.

pub fn next_row_with_cols( &mut self, mask: usize, ) -> Result<Option<Vec<&'_ [u8]>>, NippyJarError>

Returns the current value and advances the row.

Uses a mask to only read certain columns from the row.

Trait Implementations

impl<'a, H: Clone> Clone for NippyJarCursor<'a, H>

fn clone(&self) -> NippyJarCursor<'a, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: NippyJarHeader> Debug for NippyJarCursor<'_, H>

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes