Struct odbc_api::ConnectionOptions

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

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

impl ConnectionOptions

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

impl Clone for ConnectionOptions

fn clone(&self) -> ConnectionOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ConnectionOptions

fn default() -> ConnectionOptions

Returns the “default value” for a type.

impl Copy for ConnectionOptions