Struct mysql_async::Opts

pub struct Opts { /* fields omitted */ }

Mysql connection options.

Build one with OptsBuilder.

Methods

impl Opts

pub fn from_url(url: &str) -> Result<Opts, UrlError>

pub fn get_ip_or_hostname(&self) -> &str

Address of mysql server (defaults to 127.0.0.1). Hostnames should also work.

pub fn get_tcp_port(&self) -> u16

TCP port of mysql server (defaults to 3306).

pub fn get_user(&self) -> Option<&str>

User (defaults to None).

pub fn get_pass(&self) -> Option<&str>

Password (defaults to None).

pub fn get_db_name(&self) -> Option<&str>

Database name (defaults to None).

pub fn get_init(&self) -> &[String]

Commands to execute on each new database connection.

pub fn get_tcp_keepalive(&self) -> Option<u32>

TCP keep alive timeout in milliseconds (defaults to `None).

pub fn get_tcp_nodelay(&self) -> bool

Whether TCP_NODELAY will be set for mysql connection.

pub fn get_local_infile_handler(&self) -> Option<Arc<dyn LocalInfileHandler>>

Local infile handler

pub fn get_pool_constraints(&self) -> &PoolConstraints

/// Bounds for the number of opened connections in Pool (defaults to min: 10, max: 100).

pub fn get_conn_ttl(&self) -> Option<u32>

Pool will close connection if time since last IO exceeds this value (defaults to wait_timeout).

pub fn get_stmt_cache_size(&self) -> usize

Number of prepared statements cached on the client side (per connection). Defaults to 10.

pub fn get_ssl_opts(&self) -> Option<&SslOpts>

Driver will require SSL connection if this option isn't None (default to None).

This option requires ssl feature to work.

pub fn get_perfer_socket(&self) -> bool

Will prefer socket connection if true (defaults to true).

pub fn get_prefer_socket(&self) -> bool

Prefer socket connection (defaults to true).

Will reconnect via socket (or named pipe on Windows) after TCP connection to 127.0.0.1 if true.

Will fall back to TCP on error. Use socket option to enforce socket connection.

Note

Library will query the @@socket server variable to get socket address, and this address may be incorrect in some cases (i.e. docker).

pub fn get_socket(&self) -> Option<&str>

Socket path (defaults to None).

Trait Implementations

impl From<OptsBuilder> for Opts

fn from(builder: OptsBuilder) -> Opts

Performs the conversion.

impl<T: AsRef<str> + Sized> From<T> for Opts

fn from(url: T) -> Opts

Performs the conversion.

impl Default for Opts

fn default() -> Opts

Returns the "default value" for a type.

impl Clone for Opts

fn clone(&self) -> Opts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Opts> for Opts

fn eq(&self, other: &Opts) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Opts) -> bool

This method tests for !=.

impl Eq for Opts

impl Debug for Opts

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl FromStr for Opts

type Err = UrlError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.