Struct mysql_async::OptsBuilder

pub struct OptsBuilder { /* private fields */ }

Provides a way to build Opts.

// You can use the default builder
let existing_opts = OptsBuilder::default()
    .ip_or_hostname("foo")
    .db_name(Some("bar"))
    // ..

// Or use existing T: Into<Opts>
let builder = OptsBuilder::from(existing_opts)
    .ip_or_hostname("baz")
    .tcp_port(33306)
    // ..

Implementations

impl OptsBuilder

pub fn from_opts<T>(opts: T) -> Self

where Opts: TryFrom<T>, <Opts as TryFrom<T>>::Error: Error,

Creates new builder from the given Opts.

Panic

It’ll panic if Opts::try_from(opts) returns error.

pub fn ip_or_hostname<T: Into<String>>(self, ip_or_hostname: T) -> Self

Defines server IP or hostname. See Opts::ip_or_hostname.

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

Defines TCP port. See Opts::tcp_port.

pub fn resolved_ips<T: Into<Vec<IpAddr>>>(self, ips: Option<T>) -> Self

Defines already-resolved IPs to use for the connection. When provided the connection will not perform DNS resolution and the hostname will be used only for TLS identity verification purposes.

pub fn user<T: Into<String>>(self, user: Option<T>) -> Self

Defines user name. See Opts::user.

pub fn pass<T: Into<String>>(self, pass: Option<T>) -> Self

Defines password. See Opts::pass.

pub fn db_name<T: Into<String>>(self, db_name: Option<T>) -> Self

Defines database name. See Opts::db_name.

pub fn init<T: Into<String>>(self, init: Vec<T>) -> Self

Defines initial queries. See Opts::init.

pub fn setup<T: Into<String>>(self, setup: Vec<T>) -> Self

Defines setup queries. See Opts::setup.

pub fn tcp_keepalive<T: Into<u32>>(self, tcp_keepalive: Option<T>) -> Self

Defines tcp_keepalive option. See Opts::tcp_keepalive.

pub fn tcp_nodelay(self, nodelay: bool) -> Self

Defines tcp_nodelay option. See Opts::tcp_nodelay.

pub fn local_infile_handler<T>(self, handler: Option<T>) -> Self

where T: GlobalHandler,

Defines global LOCAL INFILE handler (see crate-level docs).

pub fn pool_opts<T: Into<Option<PoolOpts>>>(self, pool_opts: T) -> Self

Defines pool options. See Opts::pool_opts.

pub fn conn_ttl<T: Into<Option<Duration>>>(self, conn_ttl: T) -> Self

Defines connection TTL. See Opts::conn_ttl.

pub fn stmt_cache_size<T>(self, cache_size: T) -> Self

where T: Into<Option<usize>>,

Defines statement cache size. See Opts::stmt_cache_size.

pub fn ssl_opts<T: Into<Option<SslOpts>>>(self, ssl_opts: T) -> Self

Defines SSL options. See Opts::ssl_opts.

pub fn prefer_socket<T: Into<Option<bool>>>(self, prefer_socket: T) -> Self

Defines prefer_socket option. See Opts::prefer_socket.

pub fn socket<T: Into<String>>(self, socket: Option<T>) -> Self

Defines socket path. See Opts::socket.

pub fn compression<T: Into<Option<Compression>>>(self, compression: T) -> Self

Defines compression. See Opts::compression.

pub fn max_allowed_packet(self, max_allowed_packet: Option<usize>) -> Self

Defines max_allowed_packet option. See Opts::max_allowed_packet.

Note that it’ll saturate to proper minimum and maximum values for this parameter (see MySql documentation).

pub fn wait_timeout(self, wait_timeout: Option<usize>) -> Self

Defines wait_timeout option. See Opts::wait_timeout.

Note that it’ll saturate to proper minimum and maximum values for this parameter (see MySql documentation).

pub fn secure_auth(self, secure_auth: bool) -> Self

Disables mysql_old_password plugin (defaults to true).

Available via secure_auth connection url parameter.

pub fn client_found_rows(self, client_found_rows: bool) -> Self

Enables or disables CLIENT_FOUND_ROWS capability. See Opts::client_found_rows.

pub fn enable_cleartext_plugin(self, enable_cleartext_plugin: bool) -> Self

Enables Client-Side Cleartext Pluggable Authentication (defaults to false).

Enables client to send passwords to the server as cleartext, without hashing or encryption (consult MySql documentation for more info).

Security Notes

Sending passwords as cleartext may be a security problem in some configurations. Please consider using TLS or encrypted tunnels for server connection.

Connection URL

Use enable_cleartext_plugin URL parameter to set this value. E.g.

let opts = Opts::from_url("mysql://localhost/db?enable_cleartext_plugin=true")?;
assert!(opts.enable_cleartext_plugin());

Trait Implementations

impl Clone for OptsBuilder

fn clone(&self) -> OptsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptsBuilder

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

Formats the value using the given formatter.

impl Default for OptsBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<OptsBuilder> for Opts

fn from(builder: OptsBuilder) -> Opts

Converts to this type from the input type.

impl PartialEq for OptsBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OptsBuilder

impl StructuralPartialEq for OptsBuilder