dnim/rust-postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc tweaks

Browse Source
This commit is contained in:
Steven Fackler 2016-07-09 22:02:49 -07:00
parent ccf94ad5ef
commit 0441c750a7
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/io/mod.rs
View File

@ -1,4 +1,4 @@
//! Types and traits for TLS adaptors.
//! Types and traits for TLS support.
pub use priv_io::Stream;
use std::error::Error;
@ -10,7 +10,7 @@ pub mod openssl;
#[cfg(feature = "with-security-framework")]
pub mod security_framework;
/// A trait implemented by TLS adaptors.
/// A trait implemented by TLS streams.
pub trait TlsStream: fmt::Debug + Read + Write + Send {
/// Returns a reference to the underlying `Stream`.
fn get_ref(&self) -> &Stream;
@ -19,7 +19,8 @@ pub trait TlsStream: fmt::Debug + Read + Write + Send {
fn get_mut(&mut self) -> &mut Stream;
}
/// A trait implemented by types that can negotiate TLS over a Postgres stream.
/// A trait implemented by types that can initiate a TLS session over a Postgres
/// stream.
pub trait TlsHandshake: fmt::Debug {
/// Performs a client-side TLS handshake, returning a wrapper around the
/// provided stream.