fix lib doc

Author: Elrendio

Cargo.toml

@@ -34,3 +34,6 @@ openssl = { version = "0.10", optional = true }
 [dependencies.native-tls]
 version = "0.2"
 optional = true
+
+[package.metadata.docs.rs]
+rustc-args = ["--cfg", "secure"]

src/ftp.rs

@@ -226,7 +226,7 @@ impl FtpStream {
     /// let mut ctx = SslContext::builder(SslMethod::tls()).unwrap();
     /// let _ = ctx.set_ca_file(Path::new("/path/to/a/cert.pem")).unwrap();
     /// let ctx = ctx.build();
-    /// let mut ftp_stream = FtpStream::connect("127.0.0.1:21").unwrap();
+    /// let (mut ftp_stream, _welcome_msg) = FtpStream::connect("127.0.0.1:21").unwrap();
     /// let mut ftp_stream = ftp_stream.into_secure(ctx).unwrap();
     /// // Do all secret things
     /// // Switch back to the insecure mode
@@ -301,7 +301,7 @@ impl FtpStream {
     /// use ftp::FtpStream;
     /// use std::time::Duration;
     ///
-    /// let stream = FtpStream::connect("127.0.0.1:21")
+    /// let (stream, _welcome_msg) = FtpStream::connect("127.0.0.1:21")
     ///                        .expect("Couldn't connect to the server...");
     /// stream.get_ref().set_read_timeout(Some(Duration::from_secs(10)))
     ///                 .expect("set_read_timeout call failed");
@@ -432,7 +432,7 @@ impl FtpStream {
     /// ```
     /// # use ftp::{FtpStream, FtpError};
     /// # use std::io::Cursor;
-    /// # let mut conn = FtpStream::connect("127.0.0.1:21").unwrap();
+    /// # let (mut conn, _welcome_msg) = FtpStream::connect("127.0.0.1:21").unwrap();
     /// # conn.login("Doe", "mumble").and_then(|_| {
     /// #     let mut reader = Cursor::new("hello, world!".as_bytes());
     /// #     conn.put("retr.txt", &mut reader)
@@ -469,7 +469,7 @@ impl FtpStream {
     /// ```
     /// # use ftp::{FtpStream, FtpError};
     /// # use std::io::Cursor;
-    /// # let mut conn = FtpStream::connect("127.0.0.1:21").unwrap();
+    /// # let (mut conn, _welcome_msg) = FtpStream::connect("127.0.0.1:21").unwrap();
     /// # conn.login("Doe", "mumble").and_then(|_| {
     /// #     let mut reader = Cursor::new("hello, world!".as_bytes());
     /// #     conn.put("simple_retr.txt", &mut reader)

src/lib.rs

@@ -9,7 +9,7 @@
 //!
 //! ```rust
 //! use ftp::FtpStream;
-//! let mut (ftp_stream, _welcome_msg) = FtpStream::connect("127.0.0.1:21").unwrap_or_else(|err|
+//! let (mut ftp_stream, _welcome_msg) = FtpStream::connect("127.0.0.1:21").unwrap_or_else(|err|
 //!     panic!("{}", err)
 //! );
 //! let _ = ftp_stream.quit();
@@ -28,43 +28,50 @@
 //! For better security it's the good practice to switch to the secure mode
 //! before authentication.
 //!
-//! ## FTPS Usage
-//!
-//! ```rust,no_run
-//! use ftp::FtpStream;
-//! use ftp::openssl::ssl::{ SslContext, SslMethod };
-//!
-//! let (ftp_stream, _welcome_msg) = FtpStream::connect("127.0.0.1:21").unwrap();
-//! let ctx = SslContext::builder(SslMethod::tls()).unwrap().build();
-//! // Switch to the secure mode
-//! let mut ftp_stream = ftp_stream.into_secure(ctx).unwrap();
-//! ftp_stream.login("anonymous", "anonymous").unwrap();
-//! // Do other secret stuff
-//! // Switch back to the insecure mode (if required)
-//! let mut ftp_stream = ftp_stream.into_insecure().unwrap();
-//! // Do all public stuff
-//! let _ = ftp_stream.quit();
-//! ```
-//!
-//! ## FTPS Usage with native-tls
-//!
-//! ```rust,no_run
-//! use ftp::FtpStream;
-//! use ftp::native_tls::{TlsConnector, TlsStream};
-//!
-//! let (ftp_stream, _welcome_msg) = FtpStream::connect("127.0.0.1:21").unwrap();
-//! let mut ctx = TlsConnector::new().unwrap();
-//! // Switch to the secure mode
-//! let mut ftp_stream = ftp_stream.into_secure(ctx, "localhost").unwrap();
-//! ftp_stream.login("anonymous", "anonymous").unwrap();
-//! // Do other secret stuff
-//! // Switch back to the insecure mode (if required)
-//! let mut ftp_stream = ftp_stream.into_insecure().unwrap();
-//! // Do all public stuff
-//! let _ = ftp_stream.quit();
-//! ```
-//!
+#![cfg_attr(
+	all(feature = "secure", not(feature = "native-tls")),
+	doc = r##"
+## FTPS Usage
+
+```rust,no_run
+use ftp::FtpStream;
+use ftp::openssl::ssl::{ SslContext, SslMethod };
+
+let (ftp_stream, _welcome_msg) = FtpStream::connect("127.0.0.1:21").unwrap();
+let ctx = SslContext::builder(SslMethod::tls()).unwrap().build();
+// Switch to the secure mode
+let mut ftp_stream = ftp_stream.into_secure(ctx).unwrap();
+ftp_stream.login("anonymous", "anonymous").unwrap();
+// Do other secret stuff
+// Switch back to the insecure mode (if required)
+let mut ftp_stream = ftp_stream.into_insecure().unwrap();
+// Do all public stuff
+let _ = ftp_stream.quit();
+```
+"##
+)]
+#![cfg_attr(
+	all(feature = "secure", feature = "native-tls"),
+	doc = r##"
+## FTPS Usage
+
+```rust,no_run
+use ftp::FtpStream;
+use ftp::native_tls::{TlsConnector, TlsStream};
 
+let (ftp_stream, _welcome_msg) = FtpStream::connect("127.0.0.1:21").unwrap();
+let mut ctx = TlsConnector::new().unwrap();
+// Switch to the secure mode
+let mut ftp_stream = ftp_stream.into_secure(ctx, "localhost").unwrap();
+ftp_stream.login("anonymous", "anonymous").unwrap();
+// Do other secret stuff
+// Switch back to the insecure mode (if required)
+let mut ftp_stream = ftp_stream.into_insecure().unwrap();
+// Do all public stuff
+let _ = ftp_stream.quit();
+```
+"##
+)]
 #[macro_use]
 extern crate lazy_static;
 extern crate chrono;