Struct odbc_api::handles::OutputStringBuffer

pub struct OutputStringBuffer { /* fields omitted */ }

We use this as an output buffer for strings. Allows for detecting truncation.

Implementations

impl OutputStringBuffer

pub fn with_buffer_size(max_str_len: usize) -> Self

Creates a new instance of an output string buffer which can hold strings up to a size of max_str_len characters.

pub fn mut_buf_ptr(&mut self) -> *mut u16

Ptr to the internal buffer. Used by ODBC API calls to fill the buffer.

pub fn buf_len(&self) -> i16

Length of the internal buffer in characters excluding the terminating zero.

pub fn mut_actual_len_ptr(&mut self) -> *mut i16

Mutable pointer to actual output string length. Used by ODBC API calls to report truncation.

pub fn as_ucstr(&self) -> &U16CStr

Interpret buffer as UTF16 string. Panics if no terminating zero present.

pub fn to_utf8(&self) -> String

Call this method to extract string from buffer after ODBC has filled it.

pub fn is_truncated(&self) -> bool

True if the buffer had not been large enough to hold the string.