Type alias CursorState

CursorState: "idle" | "started" | "closed"
Overview

Represents the status of some AbstractCursor.

Status Description
idle The cursor is uninitialized/not in use, and may be modified freely.
started The cursor is currently in use, and cannot be modified w/out rewinding or cloning.
closed The cursor is closed, and cannot be used w/out rewinding or cloning.

State Transitions
  • idle → started: Occurs when next(), hasNext(), iteration, or any other method that fetches data is called.
  • started → closed: Occurs when iteration completes, an error is thrown during iteration, or close() is explicitly called.
  • * → idle: Occurs when rewind() is called on any cursor.

See

AbstractCursor.state