pub struct SzBuffer { /* private fields */ }Expand description
Use this buffer type to fetch zero terminated strings from the ODBC API. Either allocates a buffer for wide or narrow strings dependend on the features set.
Implementations§
source§impl SzBuffer
impl SzBuffer
sourcepub fn with_capacity(capacity: usize) -> Self
pub fn with_capacity(capacity: usize) -> Self
Creates a buffer which can hold at least capacity characters, excluding the terminating
zero. Or phrased differently. It will allocate one additional character to hold the
terminating zero, so the caller should not factor it into the size of capacity.
Examples found in repository?
src/environment.rs (line 473)
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
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)
.into_result_option(&self.environment)?
{
res
} else {
// No drivers present
return Ok(Vec::new());
};
// If there are, let's loop over the remaining drivers
while let Some((candidate_desc_len, candidate_attr_len)) = self
.environment
.drivers_buffer_len(FetchOrientation::Next)
.into_result_option(&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(),
)
.into_result_bool(&self.environment)?
{
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)
.into_result_option(&self.environment)?
{
res
} 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)
.into_result_option(&self.environment)?
{
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())
.into_result_bool(&self.environment)?;
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(),
)
.into_result_bool(&self.environment)?;
}
}
Ok(data_source_info)
}sourcepub fn mut_buf(&mut self) -> &mut [SqlChar]
pub fn mut_buf(&mut self) -> &mut [SqlChar]
Examples found in repository?
src/environment.rs (line 480)
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
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)
.into_result_option(&self.environment)?
{
res
} else {
// No drivers present
return Ok(Vec::new());
};
// If there are, let's loop over the remaining drivers
while let Some((candidate_desc_len, candidate_attr_len)) = self
.environment
.drivers_buffer_len(FetchOrientation::Next)
.into_result_option(&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(),
)
.into_result_bool(&self.environment)?
{
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)
.into_result_option(&self.environment)?
{
res
} 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)
.into_result_option(&self.environment)?
{
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())
.into_result_bool(&self.environment)?;
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(),
)
.into_result_bool(&self.environment)?;
}
}
Ok(data_source_info)
}sourcepub fn to_utf8(&self) -> String
pub fn to_utf8(&self) -> String
Create an owned utf-8 string from the internal buffer representation.
Examples found in repository?
src/environment.rs (line 485)
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
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)
.into_result_option(&self.environment)?
{
res
} else {
// No drivers present
return Ok(Vec::new());
};
// If there are, let's loop over the remaining drivers
while let Some((candidate_desc_len, candidate_attr_len)) = self
.environment
.drivers_buffer_len(FetchOrientation::Next)
.into_result_option(&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(),
)
.into_result_bool(&self.environment)?
{
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)
.into_result_option(&self.environment)?
{
res
} 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)
.into_result_option(&self.environment)?
{
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())
.into_result_bool(&self.environment)?;
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(),
)
.into_result_bool(&self.environment)?;
}
}
Ok(data_source_info)
}