Struct StaticFileCursor 

pub struct StaticFileCursor<'a>(/* private fields */);

Cursor of a static file segment.

Implementations

impl<'a> StaticFileCursor<'a>

pub fn new( jar: &'a NippyJar<SegmentHeader>, reader: Arc<DataReader>, ) -> ProviderResult<Self>

Returns a new StaticFileCursor.

pub fn number(&self) -> Option<u64>

Returns the current BlockNumber or TxNumber of the cursor depending on the kind of static file segment.

pub fn get( &mut self, key_or_num: KeyOrNumber<'_>, mask: usize, ) -> ProviderResult<Option<RefRow<'_>>>

Gets a row of values.

Returns None if the requested row is absent. Read and decompression failures are returned as errors.

pub fn get_one<M: ColumnSelectorOne>( &mut self, key_or_num: KeyOrNumber<'_>, ) -> ProviderResult<Option<M::FIRST>>

Gets one column value from a row.

pub fn get_two<M: ColumnSelectorTwo>( &mut self, key_or_num: KeyOrNumber<'_>, ) -> ProviderResult<Option<(M::FIRST, M::SECOND)>>

Gets two column values from a row.

pub fn get_three<M: ColumnSelectorThree>( &mut self, key_or_num: KeyOrNumber<'_>, ) -> ProviderResult<Option<(M::FIRST, M::SECOND, M::THIRD)>>

Gets three column values from a row.

Methods from Deref<Target = NippyJarCursor<'a, SegmentHeader>>

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

Returns a reference to the related NippyJar

pub 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<SmallVec<[&[u8]; 4]>>, NippyJarError>

Returns a row by its number.

pub fn next_row( &mut self, ) -> Result<Option<SmallVec<[&[u8]; 4]>>, NippyJarError>

Returns the current value and advances the row.

pub fn row_by_number_with_cols( &mut self, row: usize, mask: usize, ) -> Result<Option<SmallVec<[&[u8]; 4]>>, 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<SmallVec<[&[u8]; 4]>>, NippyJarError>

Returns the current value and advances the row.

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

Trait Implementations

impl<'a> Debug for StaticFileCursor<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for StaticFileCursor<'a>

type Target = NippyJarCursor<'a, SegmentHeader>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for StaticFileCursor<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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