Struct odbc_api::CursorImpl

pub struct CursorImpl<'open_connection, Stmt: BorrowMut<StatementImpl<'open_connection>>> { /* fields omitted */ }

Cursors are used to process and iterate the result sets returned by executing queries. Created by either a prepared query or direct execution. Usually utilized through the crate::Cursor trait.

Trait Implementations

impl<'o, S> Cursor for CursorImpl<'o, S> where
    S: BorrowMut<StatementImpl<'o>>, 

type Statement = StatementImpl<'o>

Statement type of the cursor. This is always an instantiation of crate::handles::Statement with a generic parameter indicating the lifetime of the associated connection.

unsafe fn stmt(&mut self) -> &mut Self::Statement

Provides access to the underlying statement handle.

fn describe_col(
    &self,
    column_number: u16,
    column_description: &mut ColumnDescription
) -> Result<(), Error>

Fetch a column description using the column index.

fn num_result_cols(&self) -> Result<i16, Error>

Number of columns in result set.

fn is_unsigned_column(&self, column_number: u16) -> Result<bool, Error>

true if a given column in a result set is unsigned or not a numeric type, false otherwise.

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

Binds this cursor to a buffer holding a row set.

fn col_data_type(&self, column_number: u16) -> Result<DataType, Error>

Data type of the specified column.

fn col_octet_length(&self, column_number: u16) -> Result<isize, Error>

Returns the size in bytes of the columns. For variable sized types the maximum size is returned, excluding a terminating zero.

fn col_display_size(&self, column_number: u16) -> Result<isize, Error>

Maximum number of characters required to display data from the column.

fn col_precision(&self, column_number: u16) -> Result<isize, Error>

Precision of the column.

fn col_scale(&self, column_number: u16) -> Result<isize, Error>

The applicable scale for a numeric data type. For DECIMAL and NUMERIC data types, this is the defined scale. It is undefined for all other data types.

fn col_name(&self, column_number: u16, buf: &mut Vec<u16>) -> Result<(), Error>

The column alias, if it applies. If the column alias does not apply, the column name is returned. If there is no column name or a column alias, an empty string is returned.

fn column_names(&self) -> Result<ColumnNamesIt<'_, Self>, Error>

Use this if you want to iterate over all column names and allocate a String for each one.

fn next_row(&mut self) -> Result<Option<CursorRow<'_, Self::Statement>>, Error>

Advances the cursor to the next row in the result set.

impl<'o, S> Drop for CursorImpl<'o, S> where
    S: BorrowMut<StatementImpl<'o>>, 

fn drop(&mut self)

Executes the destructor for this type.