1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
use std::{cmp::max, collections::HashMap, ptr::null_mut, sync::Mutex};
use crate::{
error::ExtendResult,
handles::{self, log_diagnostics, OutputStringBuffer, SqlResult, SqlText, State, SzBuffer},
Connection, DriverCompleteOption, Error,
};
use log::debug;
use odbc_sys::{AttrCpMatch, AttrOdbcVersion, FetchOrientation, HWnd};
#[cfg(target_os = "windows")]
// Currently only windows driver manager supports prompt.
use winit::{event_loop::EventLoop, platform::windows::WindowExtWindows, window::WindowBuilder};
#[cfg(not(feature = "odbc_version_3_5"))]
const ODBC_API_VERSION: AttrOdbcVersion = AttrOdbcVersion::Odbc3_80;
#[cfg(feature = "odbc_version_3_5")]
const ODBC_API_VERSION: AttrOdbcVersion = AttrOdbcVersion::Odbc3;
/// An ODBC 3.8 environment.
///
/// Associated with an `Environment` is any information that is global in nature, such as:
///
/// * The `Environment`'s state
/// * The current environment-level diagnostics
/// * The handles of connections currently allocated on the environment
/// * The current stetting of each environment attribute
///
/// Creating the environment is the first applications do, then interacting with an ODBC driver
/// manager. There must only be one environment in the entire process.
pub struct Environment {
environment: handles::Environment,
/// ODBC environments use interior mutability to maintain iterator state then iterating over
/// driver and / or data source information. The environment is otherwise protected by interior
/// synchronization mechanism, yet in order to be able to access to iterate over information
/// using a shared reference we need to protect the interior iteration state with a mutex of its
/// own.
/// The environment is also mutable with regards to Errors, which are accessed over the handle.
/// If multiple fallible operations are executed in parallel, we need the mutex to ensure the
/// errors are fetched by the correct thread.
internal_state: Mutex<()>,
}
unsafe impl Sync for Environment {}
impl Environment {
/// Enable or disable (default) connection pooling for ODBC connections. Call this function
/// before creating the ODBC environment for which you want to enable connection pooling.
///
/// ODBC specifies an interface to enable the driver manager to enable connection pooling for
/// your application. It is of by default, but if you use ODBC to connect to your data source
/// instead of implementing it in your application, or importing a library you may simply enable
/// it in ODBC instead.
/// Connection Pooling is governed by two attributes. The most important one is the connection
/// pooling scheme which is `Off` by default. It must be set even before you create your ODBC
/// environment. It is global mutable state on the process level. Setting it in Rust is therefore
/// unsafe.
///
/// The other one is changed via [`Self::set_connection_pooling_matching`]. It governs how a
/// connection is choosen from the pool. It defaults to strict which means the `Connection` you
/// get from the pool will have exactly the attributes specified in the connection string.
///
/// See:
/// <https://docs.microsoft.com/en-us/sql/odbc/reference/develop-app/driver-manager-connection-pooling>
///
/// # Example
///
/// ```
/// use lazy_static::lazy_static;
/// use odbc_api::{Environment, sys::{AttrConnectionPooling, AttrCpMatch}};
///
/// lazy_static! {
/// pub static ref ENV: Environment = unsafe {
/// // Enable connection pooling. Let driver decide wether the attributes of two connection
/// // are similar enough to change the attributes of a pooled one, to fit the requested
/// // connection, or if it is cheaper to create a new Connection from scratch.
/// // See <https://docs.microsoft.com/en-us/sql/odbc/reference/develop-app/driver-aware-connection-pooling>
/// Environment::set_connection_pooling(AttrConnectionPooling::DriverAware).unwrap();
/// let mut env = Environment::new().unwrap();
/// // Strict is the default, and is set here to be explicit about it.
/// env.set_connection_pooling_matching(AttrCpMatch::Strict).unwrap();
/// env
/// };
/// }
/// ```
///
/// # Safety
///
/// > An ODBC driver must be fully thread-safe, and connections must not have thread affinity to
/// > support connection pooling. This means the driver is able to handle a call on any thread
/// > at any time and is able to connect on one thread, to use the connection on another thread,
/// > and to disconnect on a third thread.
pub unsafe fn set_connection_pooling(
scheme: odbc_sys::AttrConnectionPooling,
) -> Result<(), Error> {
match handles::Environment::set_connection_pooling(scheme) {
SqlResult::Error { .. } => Err(Error::FailedSettingConnectionPooling),
SqlResult::Success(()) | SqlResult::SuccessWithInfo(()) => Ok(()),
}
}
/// Determines how a connection is chosen from a connection pool. When [`Self::connect`],
/// [`Self::connect_with_connection_string`] or [`Self::driver_connect`] is called, the Driver
/// Manager determines which connection is reused from the pool. The Driver Manager tries to
/// match the connection options in the call and the connection attributes set by the
/// application to the keywords and connection attributes of the connections in the pool. The
/// value of this attribute determines the level of precision of the matching criteria.
///
/// The following values are used to set the value of this attribute:
///
/// * [`crate::sys::AttrCpMatch::Strict`] = Only connections that exactly match the connection
/// options in the call and the connection attributes set by the application are reused. This is
/// the default.
/// * [`crate::sys::AttrCpMatch::Relaxed`] = Connections with matching connection string \
/// keywords can be used. Keywords must match, but not all connection attributes must match.
pub fn set_connection_pooling_matching(&mut self, matching: AttrCpMatch) -> Result<(), Error> {
self.environment
.set_connection_pooling_matching(matching)
.into_result(&self.environment)
}
/// Entry point into this API. Allocates a new ODBC Environment and declares to the driver
/// manager that the Application wants to use ODBC version 3.8.
///
/// # Safety
///
/// There may only be one ODBC environment in any process at any time. Take care using this
/// function in unit tests, as these run in parallel by default in Rust. Also no library should
/// probably wrap the creation of an odbc environment into a safe function call. This is because
/// using two of these "safe" libraries at the same time in different parts of your program may
/// lead to race condition thus violating Rust's safety guarantees.
///
/// Creating one environment in your binary is safe however.
pub fn new() -> Result<Self, Error> {
let result = handles::Environment::new();
let environment = match result {
SqlResult::Success(env) => env,
SqlResult::SuccessWithInfo(env) => {
log_diagnostics(&env);
env
}
SqlResult::Error { .. } => return Err(Error::FailedAllocatingEnvironment),
};
debug!("ODBC Environment created.");
let result = environment
.declare_version(ODBC_API_VERSION)
.into_result(&environment);
// Translate invalid attribute into a more meaningful error, provided the additional
// context that we know we tried to set version number.
result.provide_context_for_diagnostic(|record, function| match record.state {
// INVALID_STATE_TRANSACTION has been seen with some really old version of unixODBC on
// a CentOS used to build manylinux wheels, with the preinstalled ODBC version.
// INVALID_ATTRIBUTE_VALUE is the correct status code to emit for a driver manager if it
// does not know the version and has been seen with an unknown version of unixODBC on an
// Oracle Linux.
State::INVALID_STATE_TRANSACTION | State::INVALID_ATTRIBUTE_VALUE => {
Error::UnsupportedOdbcApiVersion(record)
}
_ => Error::Diagnostics { record, function },
})?;
Ok(Self {
environment,
internal_state: Mutex::new(()),
})
}
/// Allocates a connection handle and establishes connections to a driver and a data source.
///
/// * See [Connecting with SQLConnect][1]
/// * See [SQLConnectFunction][2]
///
/// # Arguments
///
/// * `data_source_name` - Data source name. The data might be located on the same computer as
/// the program, or on another computer somewhere on a network.
/// * `user` - User identifier.
/// * `pwd` - Authentication string (typically the password).
///
/// # Example
///
/// ```no_run
/// use odbc_api::Environment;
///
/// let env = Environment::new()?;
///
/// let mut conn = env.connect("YourDatabase", "SA", "My@Test@Password1")?;
/// # Ok::<(), odbc_api::Error>(())
/// ```
///
/// [1]: https://docs.microsoft.com/sql/odbc/reference/syntax/sqlconnect-function
/// [2]: https://docs.microsoft.com/sql/odbc/reference/syntax/sqlconnect-function
pub fn connect(
&self,
data_source_name: &str,
user: &str,
pwd: &str,
) -> Result<Connection<'_>, Error> {
let data_source_name = SqlText::new(data_source_name);
let user = SqlText::new(user);
let pwd = SqlText::new(pwd);
let mut connection = self.allocate_connection()?;
connection
.connect(&data_source_name, &user, &pwd)
.into_result(&connection)?;
Ok(Connection::new(connection))
}
/// Allocates a connection handle and establishes connections to a driver and a data source.
///
/// An alternative to `connect`. It supports data sources that require more connection
/// information than the three arguments in `connect` and data sources that are not defined in
/// the system information.
///
/// To find out your connection string try: <https://www.connectionstrings.com/>
///
/// # Example
///
/// ```no_run
/// use odbc_api::Environment;
///
/// let env = Environment::new()?;
///
/// let connection_string = "
/// Driver={ODBC Driver 17 for SQL Server};\
/// Server=localhost;\
/// UID=SA;\
/// PWD=My@Test@Password1;\
/// ";
///
/// let mut conn = env.connect_with_connection_string(connection_string)?;
/// # Ok::<(), odbc_api::Error>(())
/// ```
pub fn connect_with_connection_string(
&self,
connection_string: &str,
) -> Result<Connection<'_>, Error> {
let connection_string = SqlText::new(connection_string);
let mut connection = self.allocate_connection()?;
connection
.connect_with_connection_string(&connection_string)
.into_result(&connection)?;
Ok(Connection::new(connection))
}
/// Allocates a connection handle and establishes connections to a driver and a data source.
///
/// An alternative to `connect` and `connect_with_connection_string`. This method can be
/// provided with an incomplete or even empty connection string. If any additional information
/// is required, the driver manager/driver will attempt to create a prompt to allow the user to
/// provide the additional information.
///
/// If the connection is successful, the complete connection string (including any information
/// provided by the user through a prompt) is returned.
///
/// # Parameters
///
/// * `connection_string`: Connection string.
/// * `completed_connection_string`: Output buffer with the complete connection string. It is
/// recommended to choose a buffer with at least `1024` bytes length. **Note**: Some driver
/// implementation have poor error handling in case the provided buffer is too small. At the
/// time of this writing:
/// * Maria DB crashes with STATUS_TACK_BUFFER_OVERRUN
/// * SQLite does not change the output buffer at all and does not indicate truncation.
/// * `driver_completion`: Specifies how and if the driver manager uses a prompt to complete
/// the provided connection string. For arguments other than
/// [`crate::DriverCompleteOption::NoPrompt`] this method is going to create a message only
/// parent window for you on windows. On other platform this method is going to panic. In case
/// you want to provide your own parent window please use [`Self::driver_connect_with_hwnd`].
///
/// # Examples
///
/// In the first example, we intentionally provide a blank connection string so the user will be
/// prompted to select a data source to use. Note that this functionality is only available on
/// windows.
///
/// ```no_run
/// use odbc_api::{Environment, handles::OutputStringBuffer, DriverCompleteOption};
///
/// let env = Environment::new()?;
///
/// let mut output_buffer = OutputStringBuffer::with_buffer_size(1024);
/// let connection = env.driver_connect(
/// "",
/// &mut output_buffer,
/// DriverCompleteOption::Prompt,
/// )?;
///
/// // Check that the output buffer has been large enough to hold the entire connection string.
/// assert!(!output_buffer.is_truncated());
///
/// // Now `connection_string` will contain the data source selected by the user.
/// let connection_string = output_buffer.to_utf8();
/// # Ok::<_,odbc_api::Error>(())
/// ```
///
/// In the following examples we specify a DSN that requires login credentials, but the DSN does
/// not provide those credentials. Instead, the user will be prompted for a UID and PWD. The
/// returned `connection_string` will contain the `UID` and `PWD` provided by the user. Note
/// that this functionality is currently only available on windows targets.
///
/// ```
/// # use odbc_api::DriverCompleteOption;
/// # #[cfg(target_os = "windows")]
/// # fn f(
/// # mut output_buffer: odbc_api::handles::OutputStringBuffer,
/// # env: odbc_api::Environment,
/// # ) -> Result<(), odbc_api::Error> {
/// let without_uid_or_pwd = "DSN=SomeSharedDatabase;";
/// let connection = env.driver_connect(
/// &without_uid_or_pwd,
/// &mut output_buffer,
/// DriverCompleteOption::Complete,
/// )?;
/// let connection_string = output_buffer.to_utf8();
///
/// // Now `connection_string` might be something like
/// // `DSN=SomeSharedDatabase;UID=SA;PWD=My@Test@Password1;`
/// # Ok(()) }
/// ```
///
/// In this case, we use a DSN that is already sufficient and does not require a prompt. Because
/// a prompt is not needed, `window` is also not required. The returned `connection_string` will
/// be mostly the same as `already_sufficient` but the driver may append some extra attributes.
///
/// ```
/// # use odbc_api::DriverCompleteOption;
/// # fn f(
/// # mut output_buffer: odbc_api::handles::OutputStringBuffer,
/// # env: odbc_api::Environment,
/// # ) -> Result<(), odbc_api::Error> {
/// let already_sufficient = "DSN=MicrosoftAccessFile;";
/// let connection = env.driver_connect(
/// &already_sufficient,
/// &mut output_buffer,
/// DriverCompleteOption::NoPrompt,
/// )?;
/// let connection_string = output_buffer.to_utf8();
///
/// // Now `connection_string` might be something like
/// // `DSN=MicrosoftAccessFile;DBQ=C:\Db\Example.accdb;DriverId=25;FIL=MS Access;MaxBufferSize=2048;`
/// # Ok(()) }
/// ```
pub fn driver_connect(
&self,
connection_string: &str,
completed_connection_string: &mut OutputStringBuffer,
driver_completion: DriverCompleteOption,
) -> Result<Connection<'_>, Error> {
#[cfg(target_os = "windows")]
let parent_window = match driver_completion {
DriverCompleteOption::NoPrompt => None,
_ => {
if !cfg!(target_os = "windows") {
panic!("Prompt is not supported on non windows platforms. Use `NoPrompt`.")
}
// We need a parent window, let's provide a message only window.
Some(
WindowBuilder::new()
.with_visible(false)
.build(&EventLoop::new())
.unwrap(),
)
}
};
#[cfg(target_os = "windows")]
let hwnd = parent_window
.as_ref()
.map(|window| window.hwnd())
.unwrap_or_else(null_mut);
#[cfg(not(target_os = "windows"))]
let hwnd = null_mut();
unsafe {
self.driver_connect_with_hwnd(
connection_string,
completed_connection_string,
driver_completion,
hwnd,
)
}
}
/// Allows to call driver connect with a user supplied HWnd. Same as [`Self::driver_connect`],
/// but with the possibility to provide your own parent window handle in case you want to show
/// a prompt to the user.
///
/// # Safety
///
/// `parent_window` must be a valid window handle, to a window type supported by the ODBC driver
/// manager. On windows this is a plain window handle, which is of course understood by the
/// windows built in ODBC driver manager. Other working combinations are unknown to the author.
pub unsafe fn driver_connect_with_hwnd(
&self,
connection_string: &str,
completed_connection_string: &mut OutputStringBuffer,
driver_completion: DriverCompleteOption,
parent_window: HWnd,
) -> Result<Connection<'_>, Error> {
let mut connection = self.allocate_connection()?;
let connection_string = SqlText::new(connection_string);
connection
.driver_connect(
&connection_string,
parent_window,
completed_connection_string,
driver_completion.as_sys(),
)
.map(|res| res.into_result(&connection))
.unwrap_or(Err(Error::AbortedConnectionStringCompletion))?;
Ok(Connection::new(connection))
}
/// Get information about available drivers. Only 32 or 64 Bit drivers will be listed, depending
/// on wether you are building a 32 Bit or 64 Bit application.
///
/// # Example
///
/// ```no_run
/// use odbc_api::Environment;
///
/// let env = Environment::new ()?;
/// for driver_info in env.drivers()? {
/// println!("{:#?}", driver_info);
/// }
///
/// # Ok::<_, odbc_api::Error>(())
/// ```
pub fn drivers(&self) -> Result<Vec<DriverInfo>, Error> {
let mut driver_info = Vec::new();
// Since we have exclusive ownership of the environment handle and we take the lock, we can
// guarantee that this method is currently the only one changing the state of the internal
// iterators of the environment.
let _lock = self.internal_state.lock().unwrap();
unsafe {
// Find required buffer size to avoid truncation.
let (mut desc_len, mut attr_len) = if let Some(res) = self
.environment
// Start with first so we are independent of state
.drivers_buffer_len(FetchOrientation::First)
{
res.into_result(&self.environment)?
} else {
// No drivers present
return Ok(Vec::new());
};
// If there are let's loop over the rest
while let Some(res) = self.environment.drivers_buffer_len(FetchOrientation::Next) {
let (candidate_desc_len, candidate_attr_len) =
res.into_result(&self.environment)?;
desc_len = max(candidate_desc_len, desc_len);
attr_len = max(candidate_attr_len, attr_len);
}
// Allocate +1 character extra for terminating zero
let mut desc_buf = SzBuffer::with_capacity(desc_len as usize);
let mut attr_buf = SzBuffer::with_capacity(attr_len as usize);
while self
.environment
.drivers_buffer_fill(
FetchOrientation::Next,
desc_buf.mut_buf(),
attr_buf.mut_buf(),
)
.map(|res| res.into_result(&self.environment))
.transpose()?
.is_some()
{
let description = desc_buf.to_utf8();
let attributes = attr_buf.to_utf8();
let attributes = attributes_iter(&attributes).collect();
driver_info.push(DriverInfo {
description,
attributes,
});
}
}
Ok(driver_info)
}
/// User and system data sources
///
/// # Example
///
/// ```no_run
/// use odbc_api::Environment;
///
/// let env = Environment::new()?;
/// for data_source in env.data_sources()? {
/// println!("{:#?}", data_source);
/// }
///
/// # Ok::<_, odbc_api::Error>(())
/// ```
pub fn data_sources(&self) -> Result<Vec<DataSourceInfo>, Error> {
self.data_sources_impl(FetchOrientation::First)
}
/// Only system data sources
///
/// # Example
///
/// ```no_run
/// use odbc_api::Environment;
///
/// let env = Environment::new ()?;
/// for data_source in env.system_data_sources()? {
/// println!("{:#?}", data_source);
/// }
///
/// # Ok::<_, odbc_api::Error>(())
/// ```
pub fn system_data_sources(&self) -> Result<Vec<DataSourceInfo>, Error> {
self.data_sources_impl(FetchOrientation::FirstSystem)
}
/// Only user data sources
///
/// # Example
///
/// ```no_run
/// use odbc_api::Environment;
///
/// let mut env = unsafe { Environment::new () }?;
/// for data_source in env.user_data_sources()? {
/// println!("{:#?}", data_source);
/// }
///
/// # Ok::<_, odbc_api::Error>(())
/// ```
pub fn user_data_sources(&self) -> Result<Vec<DataSourceInfo>, Error> {
self.data_sources_impl(FetchOrientation::FirstUser)
}
fn data_sources_impl(&self, direction: FetchOrientation) -> Result<Vec<DataSourceInfo>, Error> {
let mut data_source_info = Vec::new();
// Since we have exclusive ownership of the environment handle and we take the lock, we can
// guarantee that this method is currently the only one changing the state of the internal
// iterators of the environment.
let _lock = self.internal_state.lock().unwrap();
unsafe {
// Find required buffer size to avoid truncation.
let (mut server_name_len, mut driver_len) =
if let Some(res) = self.environment.data_source_buffer_len(direction) {
res.into_result(&self.environment)?
} else {
// No drivers present
return Ok(Vec::new());
};
// If there are let's loop over the rest
while let Some((candidate_name_len, candidate_decs_len)) = self
.environment
.drivers_buffer_len(FetchOrientation::Next)
.map(|res| res.into_result(&self.environment))
.transpose()?
{
server_name_len = max(candidate_name_len, server_name_len);
driver_len = max(candidate_decs_len, driver_len);
}
let mut server_name_buf = SzBuffer::with_capacity(server_name_len as usize);
let mut driver_buf = SzBuffer::with_capacity(driver_len as usize);
let mut not_empty = self
.environment
.data_source_buffer_fill(direction, server_name_buf.mut_buf(), driver_buf.mut_buf())
.map(|res| res.into_result(&self.environment))
.transpose()?
.is_some();
while not_empty {
let server_name = server_name_buf.to_utf8();
let driver = driver_buf.to_utf8();
data_source_info.push(DataSourceInfo {
server_name,
driver,
});
not_empty = self
.environment
.data_source_buffer_fill(
FetchOrientation::Next,
server_name_buf.mut_buf(),
driver_buf.mut_buf(),
)
.map(|res| res.into_result(&self.environment))
.transpose()?
.is_some()
}
}
Ok(data_source_info)
}
fn allocate_connection(&self) -> Result<handles::Connection, Error> {
// Hold lock diagnostics errors are consumed in this thread.
let _lock = self.internal_state.lock().unwrap();
self.environment
.allocate_connection()
.into_result(&self.environment)
}
}
/// Struct holding information available on a driver. Can be obtained via [`Environment::drivers`].
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct DriverInfo {
/// Name of the ODBC driver
pub description: String,
/// Attributes values of the driver by key
pub attributes: HashMap<String, String>,
}
/// Holds name and description of a datasource
///
/// Can be obtained via [`Environment::data_sources`]
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct DataSourceInfo {
/// Name of the data source
pub server_name: String,
/// Description of the data source
pub driver: String,
}
/// Called by drivers to pares list of attributes
///
/// Key value pairs are separated by `\0`. Key and value are separated by `=`
fn attributes_iter(attributes: &str) -> impl Iterator<Item = (String, String)> + '_ {
attributes
.split('\0')
.take_while(|kv_str| *kv_str != String::new())
.map(|kv_str| {
let mut iter = kv_str.split('=');
let key = iter.next().unwrap();
let value = iter.next().unwrap();
(key.to_string(), value.to_string())
})
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn parse_attributes() {
let buffer = "APILevel=2\0ConnectFunctions=YYY\0CPTimeout=60\0DriverODBCVer=03.\
50\0FileUsage=0\0SQLLevel=1\0UsageCount=1\0\0";
let attributes: HashMap<_, _> = attributes_iter(buffer).collect();
assert_eq!(attributes["APILevel"], "2");
assert_eq!(attributes["ConnectFunctions"], "YYY");
assert_eq!(attributes["CPTimeout"], "60");
assert_eq!(attributes["DriverODBCVer"], "03.50");
assert_eq!(attributes["FileUsage"], "0");
assert_eq!(attributes["SQLLevel"], "1");
assert_eq!(attributes["UsageCount"], "1");
}
}