Struct odbc_api::buffers::TextRowSet

pub struct TextRowSet { /* fields omitted */ }

This row set binds a string buffer to each column, which is large enough to hold the maximum length string representation for each element in the row set at once.

Implementations

impl TextRowSet

pub fn for_cursor(
    batch_size: u32,
    cursor: &impl Cursor
) -> Result<TextRowSet, Error>

Use cursor to query the display size for each column of the row set and allocates the buffers accordingly.

pub fn new(
    batch_size: u32,
    max_str_lengths: impl Iterator<Item = usize>
) -> Self

Creates a text buffer large enough to hold batch_size rows with one column for each item max_str_lengths of respective size.

pub fn at(&self, col_index: usize, row_index: usize) -> Option<&[u8]>

Access the element at the specified position in the row set.

pub fn at_as_str(
    &self,
    col_index: usize,
    row_index: usize
) -> Result<Option<&str>, Utf8Error>

Access the element at the specified position in the row set.

pub fn num_cols(&self) -> usize

Return the number of columns in the row set.

pub fn num_rows(&self) -> usize

Return the number of rows in the row set.

pub fn append<'a>(&mut self, row: impl Iterator<Item = Option<&'a [u8]>>)

Takes one element from the iterater for each internal column buffer and appends it to the end of the buffer. Should the buffer be not large enough to hold the element, it will be reallocated with 1.2 times its size.

This method panics if it is tried to insert elements beyond batch size. It will also panic if row does not contain at least one item for each internal column buffer.

pub fn clear(&mut self)

Sets the number of rows in the buffer to zero.

Trait Implementations

impl<'_> ParameterCollection for &'_ TextRowSet

pub fn parameter_set_size(&self) -> u32

Number of parameters in the collection. This can be different from the maximum batch size a buffer may be able to hold. Returning 0 will cause the the query not to be executed.

pub unsafe fn bind_parameters_to(
    &self,
    stmt: &mut Statement<'_>
) -> Result<(), Error>

Safety

impl RowSetBuffer for TextRowSet

pub unsafe fn bind_to_cursor(
    &mut self,
    cursor: &mut impl Cursor
) -> Result<(), Error>

Binds the buffer either column or row wise to the cursor.