Enum odbc_api::buffers::AnyBuffer

pub enum AnyBuffer {
    Binary(BinColumn),
    Text(CharColumn),
    WText(WCharColumn),
    Date(Vec<Date>),
    Time(Vec<Time>),
    Timestamp(Vec<Timestamp>),
    F64(Vec<f64>),
    F32(Vec<f32>),
    I8(Vec<i8>),
    I16(Vec<i16>),
    I32(Vec<i32>),
    I64(Vec<i64>),
    U8(Vec<u8>),
    Bit(Vec<Bit>),
    NullableDate(ColumnWithIndicator<Date>),
    NullableTime(ColumnWithIndicator<Time>),
    NullableTimestamp(ColumnWithIndicator<Timestamp>),
    NullableF64(ColumnWithIndicator<f64>),
    NullableF32(ColumnWithIndicator<f32>),
    NullableI8(ColumnWithIndicator<i8>),
    NullableI16(ColumnWithIndicator<i16>),
    NullableI32(ColumnWithIndicator<i32>),
    NullableI64(ColumnWithIndicator<i64>),
    NullableU8(ColumnWithIndicator<u8>),
    NullableBit(ColumnWithIndicator<Bit>),
}

Buffer holding a single column of either a result set or paramater

Variants

Binary(BinColumn)

A buffer for holding both nullable and required binary data.

Text(CharColumn)

A buffer for holding both nullable and required text data. Uses the system encoding for character data.

WText(WCharColumn)

A buffer for holding both nullable and required text data. Uses UTF-16 encoding

Date(Vec<Date>)

Time(Vec<Time>)

Timestamp(Vec<Timestamp>)

F64(Vec<f64>)

F32(Vec<f32>)

I8(Vec<i8>)

I16(Vec<i16>)

I32(Vec<i32>)

I64(Vec<i64>)

U8(Vec<u8>)

Bit(Vec<Bit>)

NullableDate(ColumnWithIndicator<Date>)

NullableTime(ColumnWithIndicator<Time>)

NullableTimestamp(ColumnWithIndicator<Timestamp>)

NullableF64(ColumnWithIndicator<f64>)

NullableF32(ColumnWithIndicator<f32>)

NullableI8(ColumnWithIndicator<i8>)

NullableI16(ColumnWithIndicator<i16>)

NullableI32(ColumnWithIndicator<i32>)

NullableI64(ColumnWithIndicator<i64>)

NullableU8(ColumnWithIndicator<u8>)

NullableBit(ColumnWithIndicator<Bit>)

Implementations

impl AnyBuffer

pub fn try_from_description(
    max_rows: usize,
    desc: BufferDescription
) -> Result<Self, TooLargeBufferSize>

Map buffer description to actual buffer.

pub fn from_description(max_rows: usize, desc: BufferDescription) -> Self

Map buffer description to actual buffer.

Trait Implementations

impl<'a> BoundInputSlice<'a> for AnyBuffer

type SliceMut = AnySliceMut<'a>

Intended to allow for modifying buffer contents, while leaving the bound parameter buffers valid.

unsafe fn as_view_mut(
    &'a mut self,
    parameter_index: u16,
    stmt: StatementRef<'a>
) -> Self::SliceMut

Obtain a mutable view on a parameter buffer in order to change the parameter value(s) submitted when executing the statement.

impl CData for AnyBuffer

fn cdata_type(&self) -> CDataType

The identifier of the C data type of the value buffer. When it is retrieving data from the data source with fetch, the driver converts the data to this type. When it sends data to the source, the driver converts the data from this type.

fn indicator_ptr(&self) -> *const isize

Indicates the length of variable sized types. May be zero for fixed sized types. Used to determine the size or existence of input parameters.

fn value_ptr(&self) -> *const c_void

Pointer to a value corresponding to the one described by cdata_type.

fn buffer_length(&self) -> isize

Maximum length of the type in bytes (not characters). It is required to index values in bound buffers, if more than one parameter is bound. Can be set to zero for types not bound as parameter arrays, i.e. CStr.

impl CDataMut for AnyBuffer

fn mut_indicator_ptr(&mut self) -> *mut isize

Indicates the length of variable sized types. May be zero for fixed sized types.

fn mut_value_ptr(&mut self) -> *mut c_void

Pointer to a value corresponding to the one described by cdata_type.

impl ColumnBuffer for AnyBuffer

fn fill_default(&mut self, from: usize, to: usize)

Fills the column with the default representation of values, between from and to index.

type View<'a> = AnySlice<'a>

Immutable view on the column data. Used in safe abstractions. User must not be able to access uninitialized or invalid memory of the buffer through this interface.

fn capacity(&self) -> usize

Current capacity of the column

fn view(&self, valid_rows: usize) -> AnySlice<'_>

Num rows may not exceed the actually amount of valid num_rows filled be the ODBC API. The column buffer does not know how many elements were in the last row group, and therefore can not guarantee the accessed element to be valid and in a defined state. It also can not panic on accessing an undefined element.

impl Debug for AnyBuffer

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

Formats the value using the given formatter.

impl HasDataType for AnyBuffer

fn data_type(&self) -> DataType

The SQL data as which the parameter is bound to ODBC.