Struct CursorStream 

#[non_exhaustive]
pub struct CursorStream<'a> { /* private fields */ }

A streaming cursor that yields rows one at a time from a portal.

Unlike Cursor which returns batches of rows, CursorStream provides a row-by-row iterator interface. When the current batch is exhausted, it automatically fetches the next batch from the server.

CursorStream borrows the connection mutably. You cannot use the connection while iterating. When the stream is dropped (or fully consumed), the connection is available again.

If the stream is dropped before being fully consumed, the connection is left in an inconsistent state. The Connection::needs_recovery flag is set, and you must call Connection::recover before using the connection again.

Implementations

impl<'a> CursorStream<'a>

pub async fn next(&mut self) -> Result<Option<Row>>

Fetch the next row from the stream.

Returns Ok(Some(row)) when a row is available, Ok(None) when the stream is exhausted, and Err(...) on a server or protocol error. After returning None or Err, subsequent calls return None.

pub fn columns(&self) -> &[FieldDescription]

Get the column metadata for the current result set.

pub fn is_done(&self) -> bool

Returns true if the stream has been fully consumed or encountered an error.

pub fn command_tag(&self) -> Option<&CommandTag>

Get the command tag after the stream ends.

pub async fn consume(self) -> Result<CommandTag>

Consume the remaining rows in the stream, discarding them, and close the cursor portal.

Trait Implementations

impl<'a> Drop for CursorStream<'a>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.