Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: expose getters for connect options fields #2891

Merged
merged 1 commit into from
Jan 21, 2024
Merged

feat: expose getters for connect options fields #2891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 119 additions & 21 deletions sqlx-mysql/src/options/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,20 +152,6 @@ impl MySqlConnectOptions {
self
}

/// Get the current database name.
///
/// # Example
///
/// ```rust
/// # use sqlx_core::mysql::MySqlConnectOptions;
/// let options = MySqlConnectOptions::new()
/// .database("mysqldb");
/// assert!(options.get_database().is_some());
/// ```
pub fn get_database(&self) -> Option<&str> {
self.database.as_deref()
}

/// Sets whether or with what priority a secure SSL TCP/IP connection will be negotiated
/// with the server.
///
Expand All @@ -175,7 +161,7 @@ impl MySqlConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_core::mysql::{MySqlSslMode, MySqlConnectOptions};
/// # use sqlx_mysql::{MySqlSslMode, MySqlConnectOptions};
/// let options = MySqlConnectOptions::new()
/// .ssl_mode(MySqlSslMode::Required);
/// ```
Expand All @@ -189,7 +175,7 @@ impl MySqlConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_core::mysql::{MySqlSslMode, MySqlConnectOptions};
/// # use sqlx_mysql::{MySqlSslMode, MySqlConnectOptions};
/// let options = MySqlConnectOptions::new()
/// .ssl_mode(MySqlSslMode::VerifyCa)
/// .ssl_ca("path/to/ca.crt");
Expand All @@ -204,7 +190,7 @@ impl MySqlConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_core::mysql::{MySqlSslMode, MySqlConnectOptions};
/// # use sqlx_mysql::{MySqlSslMode, MySqlConnectOptions};
/// let options = MySqlConnectOptions::new()
/// .ssl_mode(MySqlSslMode::VerifyCa)
/// .ssl_ca_from_pem(vec![]);
Expand All @@ -219,7 +205,7 @@ impl MySqlConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_core::mysql::{MySqlSslMode, MySqlConnectOptions};
/// # use sqlx_mysql::{MySqlSslMode, MySqlConnectOptions};
/// let options = MySqlConnectOptions::new()
/// .ssl_mode(MySqlSslMode::VerifyCa)
/// .ssl_client_cert("path/to/client.crt");
Expand All @@ -238,7 +224,7 @@ impl MySqlConnectOptions {
/// This is for illustration purposes only.
///
/// ```rust
/// # use sqlx_core::mysql::{MySqlSslMode, MySqlConnectOptions};
/// # use sqlx_mysql::{MySqlSslMode, MySqlConnectOptions};
///
/// const CERT: &[u8] = b"\
/// -----BEGIN CERTIFICATE-----
Expand All @@ -259,7 +245,7 @@ impl MySqlConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_core::mysql::{MySqlSslMode, MySqlConnectOptions};
/// # use sqlx_mysql::{MySqlSslMode, MySqlConnectOptions};
/// let options = MySqlConnectOptions::new()
/// .ssl_mode(MySqlSslMode::VerifyCa)
/// .ssl_client_key("path/to/client.key");
Expand All @@ -278,7 +264,7 @@ impl MySqlConnectOptions {
/// This is for illustration purposes only.
///
/// ```rust
/// # use sqlx_core::mysql::{MySqlSslMode, MySqlConnectOptions};
/// # use sqlx_mysql::{MySqlSslMode, MySqlConnectOptions};
///
/// const KEY: &[u8] = b"\
/// -----BEGIN PRIVATE KEY-----
Expand Down Expand Up @@ -348,3 +334,115 @@ impl MySqlConnectOptions {
self
}
}

impl MySqlConnectOptions {
/// Get the current host.
///
/// # Example
///
/// ```rust
/// # use sqlx_mysql::MySqlConnectOptions;
/// let options = MySqlConnectOptions::new()
/// .host("127.0.0.1");
/// assert_eq!(options.get_host(), "127.0.0.1");
/// ```
pub fn get_host(&self) -> &str {
&self.host
}

/// Get the server's port.
///
/// # Example
///
/// ```rust
/// # use sqlx_mysql::MySqlConnectOptions;
/// let options = MySqlConnectOptions::new()
/// .port(6543);
/// assert_eq!(options.get_port(), 6543);
/// ```
pub fn get_port(&self) -> u16 {
self.port
}

/// Get the socket path.
///
/// # Example
///
/// ```rust
/// # use sqlx_mysql::MySqlConnectOptions;
/// let options = MySqlConnectOptions::new()
/// .socket("/tmp");
/// assert!(options.get_socket().is_some());
/// ```
pub fn get_socket(&self) -> Option<&PathBuf> {
self.socket.as_ref()
}

/// Get the server's port.
///
/// # Example
///
/// ```rust
/// # use sqlx_mysql::MySqlConnectOptions;
/// let options = MySqlConnectOptions::new()
/// .username("foo");
/// assert_eq!(options.get_username(), "foo");
/// ```
pub fn get_username(&self) -> &str {
&self.username
}

/// Get the current database name.
///
/// # Example
///
/// ```rust
/// # use sqlx_mysql::MySqlConnectOptions;
/// let options = MySqlConnectOptions::new()
/// .database("postgres");
/// assert!(options.get_database().is_some());
/// ```
pub fn get_database(&self) -> Option<&str> {
self.database.as_deref()
}

/// Get the SSL mode.
///
/// # Example
///
/// ```rust
/// # use sqlx_mysql::{MySqlConnectOptions, MySqlSslMode};
/// let options = MySqlConnectOptions::new();
/// assert!(matches!(options.get_ssl_mode(), MySqlSslMode::Preferred));
/// ```
pub fn get_ssl_mode(&self) -> MySqlSslMode {
self.ssl_mode
}

/// Get the server charset.
///
/// # Example
///
/// ```rust
/// # use sqlx_mysql::MySqlConnectOptions;
/// let options = MySqlConnectOptions::new();
/// assert_eq!(options.get_charset(), "utf8mb4");
/// ```
pub fn get_charset(&self) -> &str {
&self.charset
}

/// Get the server collation.
///
/// # Example
///
/// ```rust
/// # use sqlx_mysql::MySqlConnectOptions;
/// let options = MySqlConnectOptions::new()
/// .collation("collation");
/// assert!(options.get_collation().is_some());
/// ```
pub fn get_collation(&self) -> Option<&str> {
self.collation.as_deref()
}
}
Loading
Loading