Skip to content

Commit 2a6889f

Browse files
sfacklersfackler
committed
Rename SslMode to TlsMode
TLS has been a thing since 1999 - time to use it rather than SSL!
1 parent 2e25862 commit 2a6889f

6 files changed

Lines changed: 136 additions & 136 deletions

File tree

‎src/lib.rs‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//! ```rust,no_run
44
//! extern crate postgres;
55
//!
6-
//! use postgres::{Connection, SslMode};
6+
//! use postgres::{Connection, TlsMode};
77
//!
88
//! struct Person {
99
//! id: i32,
@@ -12,7 +12,7 @@
1212
//! }
1313
//!
1414
//! fn main() {
15-
//! let conn = Connection::connect("postgresql://postgres@localhost", SslMode::None)
15+
//! let conn = Connection::connect("postgresql://postgres@localhost", TlsMode::None)
1616
//! .unwrap();
1717
//!
1818
//! conn.execute("CREATE TABLE person (
@@ -259,18 +259,18 @@ pub struct CancelData {
259259
/// # Example
260260
///
261261
/// ```rust,no_run
262-
/// # use postgres::{Connection, SslMode};
262+
/// # use postgres::{Connection, TlsMode};
263263
/// # use std::thread;
264264
/// # let url = "";
265-
/// let conn = Connection::connect(url, SslMode::None).unwrap();
265+
/// let conn = Connection::connect(url, TlsMode::None).unwrap();
266266
/// let cancel_data = conn.cancel_data();
267267
/// thread::spawn(move || {
268268
/// conn.execute("SOME EXPENSIVE QUERY", &[]).unwrap();
269269
/// });
270-
/// postgres::cancel_query(url, SslMode::None, &cancel_data).unwrap();
270+
/// postgres::cancel_query(url, TlsMode::None, &cancel_data).unwrap();
271271
/// ```
272272
pub fn cancel_query<T>(params: T,
273-
ssl: SslMode,
273+
ssl: TlsMode,
274274
data: &CancelData)
275275
-> result::Result<(), ConnectError>
276276
where T: IntoConnectParams
@@ -299,9 +299,9 @@ fn desynchronized() -> std_io::Error {
299299
error")
300300
}
301301

302-
/// Specifies the SSL support requested for a new connection.
302+
/// Specifies the TLS support requested for a new connection.
303303
#[derive(Debug)]
304-
pub enum SslMode<'a> {
304+
pub enum TlsMode<'a> {
305305
/// The connection will not use SSL.
306306
None,
307307
/// The connection will use SSL if the backend supports it.
@@ -339,7 +339,7 @@ impl Drop for InnerConnection {
339339
}
340340

341341
impl InnerConnection {
342-
fn connect<T>(params: T, ssl: SslMode) -> result::Result<InnerConnection, ConnectError>
342+
fn connect<T>(params: T, ssl: TlsMode) -> result::Result<InnerConnection, ConnectError>
343343
where T: IntoConnectParams
344344
{
345345
let params = try!(params.into_connect_params().map_err(ConnectError::ConnectParams));
@@ -994,21 +994,21 @@ impl Connection {
994994
/// # Examples
995995
///
996996
/// ```rust,no_run
997-
/// use postgres::{Connection, SslMode};
997+
/// use postgres::{Connection, TlsMode};
998998
///
999999
/// let url = "postgresql://postgres:hunter2@localhost:2994/foodb";
1000-
/// let conn = Connection::connect(url, SslMode::None).unwrap();
1000+
/// let conn = Connection::connect(url, TlsMode::None).unwrap();
10011001
/// ```
10021002
///
10031003
/// ```rust,no_run
1004-
/// use postgres::{Connection, SslMode};
1004+
/// use postgres::{Connection, TlsMode};
10051005
///
10061006
/// let url = "postgresql://postgres@%2Frun%2Fpostgres";
1007-
/// let conn = Connection::connect(url, SslMode::None).unwrap();
1007+
/// let conn = Connection::connect(url, TlsMode::None).unwrap();
10081008
/// ```
10091009
///
10101010
/// ```rust,no_run
1011-
/// use postgres::{Connection, UserInfo, ConnectParams, SslMode, ConnectTarget};
1011+
/// use postgres::{Connection, UserInfo, ConnectParams, TlsMode, ConnectTarget};
10121012
/// # use std::path::PathBuf;
10131013
///
10141014
/// # #[cfg(feature = "unix_socket")]
@@ -1024,10 +1024,10 @@ impl Connection {
10241024
/// database: None,
10251025
/// options: vec![],
10261026
/// };
1027-
/// let conn = Connection::connect(params, SslMode::None).unwrap();
1027+
/// let conn = Connection::connect(params, TlsMode::None).unwrap();
10281028
/// # }
10291029
/// ```
1030-
pub fn connect<T>(params: T, ssl: SslMode) -> result::Result<Connection, ConnectError>
1030+
pub fn connect<T>(params: T, ssl: TlsMode) -> result::Result<Connection, ConnectError>
10311031
where T: IntoConnectParams
10321032
{
10331033
InnerConnection::connect(params, ssl).map(|conn| Connection { conn: RefCell::new(conn) })
@@ -1052,8 +1052,8 @@ impl Connection {
10521052
/// # Example
10531053
///
10541054
/// ```rust,no_run
1055-
/// # use postgres::{Connection, SslMode};
1056-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
1055+
/// # use postgres::{Connection, TlsMode};
1056+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
10571057
/// # let bar = 1i32;
10581058
/// # let baz = true;
10591059
/// let rows_updated = conn.execute("UPDATE foo SET bar = $1 WHERE baz = $2", &[&bar, &baz])
@@ -1088,8 +1088,8 @@ impl Connection {
10881088
/// # Example
10891089
///
10901090
/// ```rust,no_run
1091-
/// # use postgres::{Connection, SslMode};
1092-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
1091+
/// # use postgres::{Connection, TlsMode};
1092+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
10931093
/// # let baz = true;
10941094
/// for row in &conn.query("SELECT foo FROM bar WHERE baz = $1", &[&baz]).unwrap() {
10951095
/// let foo: i32 = row.get("foo");
@@ -1124,8 +1124,8 @@ impl Connection {
11241124
/// # Example
11251125
///
11261126
/// ```rust,no_run
1127-
/// # use postgres::{Connection, SslMode};
1128-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
1127+
/// # use postgres::{Connection, TlsMode};
1128+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
11291129
/// let trans = conn.transaction().unwrap();
11301130
/// trans.execute("UPDATE foo SET bar = 10", &[]).unwrap();
11311131
/// // ...
@@ -1160,9 +1160,9 @@ impl Connection {
11601160
/// # Example
11611161
///
11621162
/// ```rust,no_run
1163-
/// # use postgres::{Connection, SslMode};
1163+
/// # use postgres::{Connection, TlsMode};
11641164
/// # let x = 10i32;
1165-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
1165+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
11661166
/// # let (a, b) = (0i32, 1i32);
11671167
/// # let updates = vec![(&a, &b)];
11681168
/// let stmt = conn.prepare("UPDATE foo SET bar = $1 WHERE baz = $2").unwrap();
@@ -1184,9 +1184,9 @@ impl Connection {
11841184
/// # Example
11851185
///
11861186
/// ```rust,no_run
1187-
/// # use postgres::{Connection, SslMode};
1187+
/// # use postgres::{Connection, TlsMode};
11881188
/// # let x = 10i32;
1189-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
1189+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
11901190
/// # let (a, b) = (0i32, 1i32);
11911191
/// # let updates = vec![(&a, &b)];
11921192
/// let stmt = conn.prepare_cached("UPDATE foo SET bar = $1 WHERE baz = $2").unwrap();
@@ -1239,8 +1239,8 @@ impl Connection {
12391239
/// # Example
12401240
///
12411241
/// ```rust,no_run
1242-
/// # use postgres::{Connection, SslMode, Result};
1243-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
1242+
/// # use postgres::{Connection, TlsMode, Result};
1243+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
12441244
/// conn.batch_execute("
12451245
/// CREATE TABLE person (
12461246
/// id SERIAL PRIMARY KEY,

‎src/priv_io.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ use std::os::unix::io::{AsRawFd, RawFd};
1515
#[cfg(windows)]
1616
use std::os::windows::io::{AsRawSocket, RawSocket};
1717

18-
use {SslMode, ConnectParams, ConnectTarget};
18+
use {TlsMode, ConnectParams, ConnectTarget};
1919
use error::ConnectError;
2020
use io::TlsStream;
2121
use message::{self, WriteMessage};
@@ -159,14 +159,14 @@ fn open_socket(params: &ConnectParams) -> Result<InternalStream, ConnectError> {
159159
}
160160

161161
pub fn initialize_stream(params: &ConnectParams,
162-
ssl: SslMode)
162+
ssl: TlsMode)
163163
-> Result<Box<TlsStream>, ConnectError> {
164164
let mut socket = Stream(try!(open_socket(params)));
165165

166166
let (ssl_required, negotiator) = match ssl {
167-
SslMode::None => return Ok(Box::new(socket)),
168-
SslMode::Prefer(negotiator) => (false, negotiator),
169-
SslMode::Require(negotiator) => (true, negotiator),
167+
TlsMode::None => return Ok(Box::new(socket)),
168+
TlsMode::Prefer(negotiator) => (false, negotiator),
169+
TlsMode::Require(negotiator) => (true, negotiator),
170170
};
171171

172172
try!(socket.write_message(&Frontend::SslRequest { code: message::SSL_CODE }));

‎src/rows.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ impl<'a> Row<'a> {
186186
/// # Example
187187
///
188188
/// ```rust,no_run
189-
/// # use postgres::{Connection, SslMode};
190-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
189+
/// # use postgres::{Connection, TlsMode};
190+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
191191
/// let stmt = conn.prepare("SELECT foo, bar from BAZ").unwrap();
192192
/// for row in &stmt.query(&[]).unwrap() {
193193
/// let foo: i32 = row.get(0);

‎src/stmt.rs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ impl<'conn> Statement<'conn> {
116116
/// # Example
117117
///
118118
/// ```rust,no_run
119-
/// # use postgres::{Connection, SslMode};
120-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
119+
/// # use postgres::{Connection, TlsMode};
120+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
121121
/// # let bar = 1i32;
122122
/// # let baz = true;
123123
/// let stmt = conn.prepare("UPDATE foo SET bar = $1 WHERE baz = $2").unwrap();
@@ -187,8 +187,8 @@ impl<'conn> Statement<'conn> {
187187
/// # Example
188188
///
189189
/// ```rust,no_run
190-
/// # use postgres::{Connection, SslMode};
191-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
190+
/// # use postgres::{Connection, TlsMode};
191+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
192192
/// let stmt = conn.prepare("SELECT foo FROM bar WHERE baz = $1").unwrap();
193193
/// # let baz = true;
194194
/// for row in &stmt.query(&[&baz]).unwrap() {
@@ -257,8 +257,8 @@ impl<'conn> Statement<'conn> {
257257
/// # Examples
258258
///
259259
/// ```rust,no_run
260-
/// # use postgres::{Connection, SslMode};
261-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
260+
/// # use postgres::{Connection, TlsMode};
261+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
262262
/// conn.batch_execute("CREATE TABLE people (id INT PRIMARY KEY, name VARCHAR)").unwrap();
263263
/// let stmt = conn.prepare("COPY people FROM STDIN").unwrap();
264264
/// stmt.copy_in(&[], &mut "1\tjohn\n2\tjane\n".as_bytes()).unwrap();
@@ -348,8 +348,8 @@ impl<'conn> Statement<'conn> {
348348
/// # Examples
349349
///
350350
/// ```rust,no_run
351-
/// # use postgres::{Connection, SslMode};
352-
/// # let conn = Connection::connect("", SslMode::None).unwrap();
351+
/// # use postgres::{Connection, TlsMode};
352+
/// # let conn = Connection::connect("", TlsMode::None).unwrap();
353353
/// conn.batch_execute("
354354
/// CREATE TABLE people (id INT PRIMARY KEY, name VARCHAR);
355355
/// INSERT INTO people (id, name) VALUES (1, 'john'), (2, 'jane');").unwrap();

0 commit comments

Comments
 (0)