Struct Opts 

pub struct Opts {

    pub tcp_nodelay: bool,
    pub capabilities: CapabilityFlags,
    pub compress: bool,
    pub db: Option<String>,
    pub host: String,
    pub port: u16,
    pub socket: Option<String>,
    pub user: String,
    pub password: String,
    pub tls: bool,
    pub upgrade_to_unix_socket: bool,
    pub init_command: Option<String>,
    pub pool_reset_conn: bool,
    pub pool_max_idle_conn: usize,
    pub pool_max_concurrency: Option<usize>,
    pub buffer_pool: Arc<BufferPool>,
}

A configuration for connection

let mut opts1 = Opts::default();
opts1.port = 5000;

let mut opts2 = Opts::try_from("mysql://root:password@localhost:3306?compress=true&tcp_nodelay=false");
opts2.compress = true;

Fields

tcp_nodelay: bool

Enable TCP_NODELAY socket option to disable Nagle’s algorithm. Unix socket is not affected.

Default: true

capabilities: CapabilityFlags

The client capabilities are CAPABILITIES_ALWAYS_ENABLED | (opts.capabilities & CAPABILITIES_CONFIGURABLE). The final negotiated capabilities are SERVER_CAPABILITIES & CLIENT_CAPABILITIES.

Default: CapabilityFlags::empty()

compress: bool

Enable compression for the connection.

Default: false

db: Option<String>

Database name to use.

Default: None

host: String

Hostname or IP address.

Default: ""

port: u16

Port number for the MySQL server.

Default: 3306

socket: Option<String>

Unix socket path. Only supported on Unix platforms.

Default: None

user: String

Username for authentication (can be empty for anonymous connections).

Default: ""

password: String

Password for authentication.

Default: ""

tls: bool

Enable TLS.

Default: false

upgrade_to_unix_socket: bool

When connected via TCP, read SELECT @@socket and reconnect to the unix socket. Only has effect on Unix platforms.

Default: true

init_command: Option<String>

SQL command to execute after connection is established.

Default: None

pool_reset_conn: bool

Reset connection state when returning to pool.

Default: true

pool_max_idle_conn: usize

Maximum number of idle connections in the pool.

Default: 100

pool_max_concurrency: Option<usize>

Maximum number of concurrent connections (active + idle). None means unlimited.

Default: None

buffer_pool: Arc<BufferPool>

BufferPool to reuse byte buffers (Vec<u8>).

Default: GLOBAL_BUFFER_POOL

Trait Implementations

impl Clone for Opts

fn clone(&self) -> Opts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Opts

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

Formats the value using the given formatter.

impl Default for Opts

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<&Url> for Opts

Parse connection options from a MySQL URL.

URL Format

mysql://[user[:password]@]host[:port][/database][?parameters]

Query Parameters

• socket
• tls (or ssl)
• compress
• tcp_nodelay
• upgrade_to_unix_socket
• init_command
• pool_reset_conn
• pool_max_idle_conn
• pool_max_concurrency

Boolean values accept: 1, 0, true, false, True, False

Examples

use zero_mysql::Opts;

// Basic connection
let opts = Opts::try_from("mysql://localhost").unwrap();

// With credentials and database
let opts = Opts::try_from("mysql://root:password@localhost:3306/mydb").unwrap();

// With query parameters
let opts = Opts::try_from("mysql://localhost?tls=true&compress=true").unwrap();

// Unix socket (hostname is ignored)
let opts = Opts::try_from("mysql://localhost?socket=/var/run/mysqld/mysqld.sock").unwrap();

type Error = Error

The type returned in the event of a conversion error.

fn try_from(url: &Url) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Opts

type Error = Error

The type returned in the event of a conversion error.

fn try_from(url: &str) -> Result<Self, Self::Error>

Performs the conversion.