Enum StreamState

pub enum StreamState {
    Waiting,
    Some(RecordBatchT<Box<dyn Array>>),
}

Available on crate feature io_ipc only.

Encodes the stream’s status after each read.

A stream is an iterator, and an iterator returns Option<Item>. The Item type in the StreamReader case is StreamState, which means that an Arrow stream may yield one of three values: (1) None, which signals that the stream is done; (2) StreamState::Some, which signals that there was data waiting in the stream and we read it; and finally (3) [Some(StreamState::Waiting)], which means that the stream is still “live”, it just doesn’t hold any data right now.

Variants

Waiting

A live stream without data

Some(RecordBatchT<Box<dyn Array>>)

Next item in the stream

Implementations

impl StreamState

pub fn unwrap(self) -> RecordBatchT<Box<dyn Array>>

Return the data inside this wrapper.

Panics

If the StreamState was Waiting.