Adding comments for connection functions

This commit is contained in:
Matt McCoy 2016-06-21 13:34:39 -04:00
parent 78f22be622
commit d949de3d0b

View file

@ -23,7 +23,7 @@ pub struct IMAPMailbox {
} }
impl IMAPStream<TcpStream> { impl IMAPStream<TcpStream> {
/// /// Creates an IMAP Stream.
pub fn connect<A: ToSocketAddrs>(addr: A) -> Result<IMAPStream<TcpStream>> { pub fn connect<A: ToSocketAddrs>(addr: A) -> Result<IMAPStream<TcpStream>> {
match TcpStream::connect(addr) { match TcpStream::connect(addr) {
Ok(stream) => { Ok(stream) => {
@ -38,7 +38,7 @@ impl IMAPStream<TcpStream> {
} }
impl IMAPStream<SslStream<TcpStream>> { impl IMAPStream<SslStream<TcpStream>> {
/// /// Creates an IMAP Stream with an Ssl wrapper.
pub fn secure_connect<A: ToSocketAddrs>(addr: A, ssl_context: SslContext) -> Result<IMAPStream<SslStream<TcpStream>>> { pub fn secure_connect<A: ToSocketAddrs>(addr: A, ssl_context: SslContext) -> Result<IMAPStream<SslStream<TcpStream>>> {
match TcpStream::connect(addr) { match TcpStream::connect(addr) {
Ok(stream) => { Ok(stream) => {