Struct mysql_async::OptsBuilder

pub struct OptsBuilder { /* fields omitted */ }

Provides a way to build Opts.

// You can create new default builder
let mut builder = OptsBuilder::new();
builder.ip_or_hostname(Some("foo"))
       .db_name(Some("bar"))
       .ssl_opts(Some(("/foo/cert.pem", None::<(String, String)>)));

// Or use existing T: Into<Opts>
let mut builder = OptsBuilder::from_opts(existing_opts);
builder.ip_or_hostname(Some("foo"))
       .db_name(Some("bar"));

Methods

impl OptsBuilder

pub fn new() -> Self

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

TCP port of mysql server (defaults to 3306).

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

User (defaults to None).

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Password (defaults to None).

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Database name (defaults to None).

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Commands to execute on each new database connection.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Set the TCP_NODELAY option for the mysql connection (defaults to true).

Setting this option to false re-enables Nagle's algorithm, which can cause unusually high latency (~40ms) but may increase maximum throughput. See #132.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn local_infile_handler<T>(&mut self, handler: Option<T>) -> &mut Self where
    T: LocalInfileHandler + 'static, 

Handler for local infile requests (defaults to None).

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn pool_min<T: Into<usize>>(&mut self, pool_min: Option<T>) -> &mut Self

Lower bound of opened connections for Pool (defaults to 10. None to reset to default).

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn pool_max<T: Into<usize>>(&mut self, pool_max: Option<T>) -> &mut Self

Lower bound of opened connections for Pool (defaults to 100. None to reset to default).

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn conn_ttl<T: Into<u32>>(&mut self, conn_ttl: Option<T>) -> &mut Self

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn stmt_cache_size<T>(&mut self, cache_size: T) -> &mut Self where
    T: Into<Option<usize>>, 

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

Call with None to reset to default.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

This option requires ssl feature to work.

Trait Implementations

impl Debug for OptsBuilder

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

Formats the value using the given formatter.

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

impl PartialEq for OptsBuilder

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

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

fn ne(&self, __arg_0: &OptsBuilder) -> bool

This method tests for !=.

impl Default for OptsBuilder

fn default() -> OptsBuilder

Returns the "default value" for a type.

impl From<OptsBuilder> for Opts

fn from(builder: OptsBuilder) -> Opts

Performs the conversion.