Update documentation

This commit is contained in:
Michael Zhang 2021-02-21 08:02:26 -06:00
parent 08b74238c6
commit 18ca5e540d
Signed by: michael
GPG key ID: BDA47A31A3C8EE6B

View file

@ -12,6 +12,26 @@
//! //!
//! If you choose not to use the high-level type-safe features of `ClientBuilder`, then you can //! If you choose not to use the high-level type-safe features of `ClientBuilder`, then you can
//! also choose to access the lower level [`Client`][self::inner::Client] directly. //! also choose to access the lower level [`Client`][self::inner::Client] directly.
//!
//! Example
//! ---
//!
//! The following example connects to `mywebsite.com:143` using STARTTLS.
//!
//! ```no_run
//! # use anyhow::Result;
//! # use panorama_imap::client::ClientConfigBuilder;
//! # async fn test() -> Result<()> {
//! let config = ClientConfigBuilder::default()
//! .hostname("mywebsite.com".to_owned())
//! .port(143)
//! .tls(false)
//! .build().unwrap();
//! let insecure = config.open().await?;
//! let unauth = insecure.upgrade().await?;
//! # Ok(())
//! # }
//! ```
mod inner; mod inner;