pub struct MySqlConnectOptions { /* private fields */ }
Expand description

Options and flags which can be used to configure a MySQL connection.

A value of MySqlConnectOptions can be parsed from a connection URI, as described by MySQL.

The generic format of the connection URL:

mysql://[host][/database][?properties]

Properties

ParameterDefaultDescription
ssl-modePREFERREDDetermines whether or with what priority a secure SSL TCP/IP connection will be negotiated. See MySqlSslMode.
ssl-caNoneSets the name of a file containing a list of trusted SSL Certificate Authorities.
statement-cache-capacity100The maximum number of prepared statements stored in the cache. Set to 0 to disable.
socketNonePath to the unix domain socket, which will be used instead of TCP if set.

Example

// URI connection string
let conn = MySqlConnection::connect("mysql://root:password@localhost/db").await?;

// Manually-constructed options
let conn = MySqlConnectOptions::new()
    .host("localhost")
    .username("root")
    .password("password")
    .database("db")
    .connect().await?;

Implementations§

source§

impl MySqlConnectOptions

source

pub fn new() -> Self

Creates a new, default set of options ready for configuration

source

pub fn host(self, host: &str) -> Self

Sets the name of the host to connect to.

The default behavior when the host is not specified, is to connect to localhost.

source

pub fn port(self, port: u16) -> Self

Sets the port to connect to at the server host.

The default port for MySQL is 3306.

source

pub fn socket(self, path: impl AsRef<Path>) -> Self

Pass a path to a Unix socket. This changes the connection stream from TCP to UDS.

By default set to None.

source

pub fn username(self, username: &str) -> Self

Sets the username to connect as.

source

pub fn password(self, password: &str) -> Self

Sets the password to connect with.

source

pub fn database(self, database: &str) -> Self

Sets the database name.

source

pub fn ssl_mode(self, mode: MySqlSslMode) -> Self

Sets whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server.

By default, the SSL mode is Preferred, and the client will first attempt an SSL connection but fallback to a non-SSL connection on failure.

Example
let options = MySqlConnectOptions::new()
    .ssl_mode(MySqlSslMode::Required);
source

pub fn ssl_ca(self, file_name: impl AsRef<Path>) -> Self

Sets the name of a file containing a list of trusted SSL Certificate Authorities.

Example
let options = MySqlConnectOptions::new()
    .ssl_mode(MySqlSslMode::VerifyCa)
    .ssl_ca("path/to/ca.crt");
source

pub fn ssl_ca_from_pem(self, pem_certificate: Vec<u8>) -> Self

Sets PEM encoded list of trusted SSL Certificate Authorities.

Example
let options = MySqlConnectOptions::new()
    .ssl_mode(MySqlSslMode::VerifyCa)
    .ssl_ca_from_pem(vec![]);
source

pub fn statement_cache_capacity(self, capacity: usize) -> Self

Sets the capacity of the connection’s statement cache in a number of stored distinct statements. Caching is handled using LRU, meaning when the amount of queries hits the defined limit, the oldest statement will get dropped.

The default cache capacity is 100 statements.

source

pub fn charset(self, charset: &str) -> Self

Sets the character set for the connection.

The default character set is utf8mb4. This is supported from MySQL 5.5.3. If you need to connect to an older version, we recommend you to change this to utf8.

source

pub fn collation(self, collation: &str) -> Self

Sets the collation for the connection.

The default collation is derived from the charset. Normally, you should only have to set the charset.

Trait Implementations§

source§

impl Clone for MySqlConnectOptions

source§

fn clone(&self) -> MySqlConnectOptions

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 ConnectOptions for MySqlConnectOptions

§

type Connection = MySqlConnection

source§

fn connect(&self) -> BoxFuture<'_, Result<Self::Connection, Error>>
where Self::Connection: Sized,

Establish a new database connection with the options specified by self.
source§

fn log_statements(&mut self, level: LevelFilter) -> &mut Self

Log executed statements with the specified level
source§

fn log_slow_statements( &mut self, level: LevelFilter, duration: Duration ) -> &mut Self

Log executed statements with a duration above the specified duration at the specified level.
source§

fn disable_statement_logging(&mut self) -> &mut Self

Entirely disables statement logging (both slow and regular).
source§

impl Debug for MySqlConnectOptions

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for MySqlConnectOptions

source§

fn default() -> Self

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

impl FromStr for MySqlConnectOptions

§

type Err = Error

The associated error which can be returned from parsing.
source§

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

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

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> 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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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>,

§

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.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V