Struct mysql::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) -> Option<&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_socket(&self) -> Option<&str>

Socket path on unix or pipe name on windows (defaults to None).

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_read_timeout(&self) -> Option<&Duration>

The timeout for each attempt to write to the server.

pub fn get_write_timeout(&self) -> Option<&Duration>

The timeout for each attempt to write to the server.

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.

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn get_init(&self) -> Vec<String>

Commands to execute on each new database connection.

pub fn get_verify_peer(&self) -> bool

Only available if ssl feature enabled.

Perform or not ssl peer verification (defaults to false). Only make sense if ssl_opts is not None.

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

Only available if ssl feature enabled.

pub fn get_tcp_nodelay(&self) -> bool

Whether TCP_NODELAY will be set for mysql connection.

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

TCP keep alive time for mysql connection.

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

Callback to handle requests for local files.

pub fn get_tcp_connect_timeout(&self) -> Option<Duration>

Tcp connect timeout (defaults to None).

pub fn bind_address(&self) -> Option<&SocketAddr>

Bind address for a client (defaults to None).

Use carefully. Will probably make pool unusable because of address already in use errors.

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_compress(&self) -> bool

If true, then client will ask for compression if server supports it (defaults to false).

pub fn get_additional_capabilities(&self) -> CapabilityFlags

Additional client capabilities to set (defaults to empty).

This value will be OR'ed with other client capabilities during connection initialisation.

Note

It is a good way to set something like CLIENT_FOUND_ROWS but you should note that it won't let you to interfere with capabilities managed by other options (like CLIENT_SSL or CLIENT_COMPRESS). Also note that some capabilities are reserved, pointless or may broke the connection, so this option should be used with caution.

Trait Implementations

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 Eq for Opts

impl PartialEq 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 Debug for Opts

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

Formats the value using the given formatter.

impl Default for Opts

fn default() -> Opts

Returns the "default value" for a type.

impl From<OptsBuilder> for Opts

fn from(builder: OptsBuilder) -> Opts

Performs the conversion.

impl<S: AsRef<str>> From<S> for Opts

fn from(url: S) -> Opts

Performs the conversion.