Struct odbc_api::CursorPolling

pub struct CursorPolling<Stmt: AsStatementRef> { /* private fields */ }

The asynchronous sibiling of CursorImpl. Use this to fetch results in asynchronous code.

Like CursorImpl this is an ODBC statement handle in cursor state. However unlike its synchronous sibling this statement handle is in asynchronous polling mode.

Implementations

impl<S> CursorPolling<S>where
    S: AsStatementRef,

pub unsafe fn new(statement: S) -> Self

Users of this library are encouraged not to call this constructor directly. This method is pubilc so users with an understanding of the raw ODBC C-API have a way to create an asynchronous cursor, after they left the safety rails of the Rust type System, in order to implement a use case not covered yet, by the safe abstractions within this crate.

Safety

statement must be in Cursor state, for the invariants of this type to hold. Preferable statement should also have asynchrous mode enabled, otherwise constructing a synchronous CursorImpl is more suitable.

pub fn bind_buffer<B>(
    self,
    row_set_buffer: B
) -> Result<BlockCursorPolling<Self, B>, Error>where
    B: RowSetBuffer,

Binds this cursor to a buffer holding a row set.

Trait Implementations

impl<S> AsStatementRef for CursorPolling<S>where
    S: AsStatementRef,

fn as_stmt_ref(&mut self) -> StatementRef<'_>

Get an exclusive reference to the underlying statement handle. This method is used to implement other more higher level methods on top of it. It is not intended to be called by users of this crate directly, yet it may serve as an escape hatch for low level usecases.

impl<S> Drop for CursorPolling<S>where
    S: AsStatementRef,

fn drop(&mut self)

Executes the destructor for this type.