Struct odbc_api::buffers::BufferDescription

pub struct BufferDescription {
    pub nullable: bool,
    pub kind: BufferKind,
}

Used to describe a column of a crate::buffers::ColumnarRowSet.

While related to to the crate::DataType of the column this is bound to, the Buffer type is different as it does not describe the type of the data source but the format the data is going to be represented in memory. While the data source is often considered to choose the buffer type the kind of processing which is supposed to be applied to the data may be even more important if choosing the a buffer for the cursor type. I.e. if you intend to print a date to standard out it may be more reasonable to bind it as Text rather than Date.

Fields

nullable: bool

This indicates whether or not the buffer will be able to represent NULL values. This will cause an indicator buffer to be bound if the selected buffer kind does not already require one anyway.

kind: BufferKind

The type of CData the buffer will be holding.

Implementations

impl BufferDescription

pub fn bytes_per_row(&self) -> usize

Returns the element size of such a buffer if bound as a columnar row. Can be used to estimate memory for columnar bindings.

Trait Implementations

impl Clone for BufferDescription

fn clone(&self) -> BufferDescription

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BufferDescription

impl Debug for BufferDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.