odbc_api

Struct ConnectionOptions

Source
pub struct ConnectionOptions {
    pub login_timeout_sec: Option<u32>,
    pub packet_size: Option<u32>,
}
Expand description

Options to be passed then opening a connection to a datasource.

Fields§

§login_timeout_sec: Option<u32>

Number of seconds to wait for a login request to complete before returning to the application. The default is driver-dependent. If 0 the timeout is disabled and a connection attempt will wait indefinitely.

If the specified timeout exceeds the maximum login timeout in the data source, the driver substitutes that value and uses the maximum login timeout instead.

This corresponds to the SQL_ATTR_LOGIN_TIMEOUT attribute in the ODBC specification.

See: https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlsetconnectattr-function

§packet_size: Option<u32>

Packet size in bytes. Not all drivers support this option.

Implementations§

Source§

impl ConnectionOptions

Source

pub fn apply(&self, handle: &Connection<'_>) -> Result<(), Error>

Set the attributes corresponding to the connection options to an allocated connection handle. Usually you would rather provide the options then creating the connection with e.g. crate::Environment::connect_with_connection_string rather than calling this method yourself.

Trait Implementations§

Source§

impl Clone for ConnectionOptions

Source§

fn clone(&self) -> ConnectionOptions

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for ConnectionOptions

Source§

fn default() -> ConnectionOptions

Returns the “default value” for a type. Read more
Source§

impl Copy for ConnectionOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.