Struct odbc_api::handles::OutputStringBuffer
source · pub struct OutputStringBuffer { /* private fields */ }
Expand description
We use this as an output buffer for strings. Allows for detecting truncation.
Implementations§
source§impl OutputStringBuffer
impl OutputStringBuffer
sourcepub fn empty() -> Self
pub fn empty() -> Self
Creates an empty string buffer. Useful if you want to e.g. use a prompt to complete the connection string, but are not interessted in the actual completed connection string.
sourcepub fn with_buffer_size(max_str_len: usize) -> Self
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 - 1
characters. `-1 because one place is needed for the terminating zero.
To hold a connection string the size should be at least 1024.
sourcepub fn mut_buf_ptr(&mut self) -> *mut SqlChar
pub fn mut_buf_ptr(&mut self) -> *mut SqlChar
Ptr to the internal buffer. Used by ODBC API calls to fill the buffer.
sourcepub fn buf_len(&self) -> i16
pub fn buf_len(&self) -> i16
Length of the internal buffer in characters including the terminating zero.
sourcepub fn mut_actual_len_ptr(&mut self) -> *mut i16
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.
sourcepub fn to_utf8(&self) -> String
pub fn to_utf8(&self) -> String
Call this method to extract string from buffer after ODBC has filled it.
sourcepub fn is_truncated(&self) -> bool
pub fn is_truncated(&self) -> bool
True if the buffer had not been large enough to hold the string.