SOMA Read Iterator Base class

SOMA Read Iterator Base class

SOMA Read Iterator Base class

Details

Virtual class that allows for read iteration of SOMA reads.

See also

BlockwiseReadIterBase, SparseReadIter, TableReadIter

Methods

Public methods

• ReadIter$new()

• ReadIter$read_complete()

• ReadIter$read_next()

• ReadIter$concat()

• ReadIter$clone()

---

Method new()

Create (lifecycle: maturing).

Usage

ReadIter$new(sr)

Arguments

sr

soma read pointer.

---

Method read_complete()

@description Check if iterated read is complete or not (lifecycle: maturing).

Usage

ReadIter$read_complete()

Returns

logical

---

Method read_next()

Read the next chunk of an iterated read. If read is complete, returns NULL and raises warning (lifecycle: maturing).

Usage

ReadIter$read_next()

Returns

NULL or one of arrow::Table, matrixZeroBasedView.

---

Method concat()

Concatenate remainder of iterator.

Usage

ReadIter$concat()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ReadIter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.