From e5175f09feb90cda1fa0935fe5bee0673a8c9cd3 Mon Sep 17 00:00:00 2001 From: Paul Woolcock Date: Wed, 22 Aug 2018 13:19:24 -0400 Subject: [PATCH] make apps::prelude and use the preludes in the tests --- src/apps.rs | 12 +++++++++++- src/entities/itemsiter.rs | 2 +- src/lib.rs | 10 +++++----- src/registration.rs | 6 +++--- src/status_builder.rs | 2 +- 5 files changed, 21 insertions(+), 11 deletions(-) diff --git a/src/apps.rs b/src/apps.rs index 00c64a2..8c89199 100644 --- a/src/apps.rs +++ b/src/apps.rs @@ -1,8 +1,18 @@ use std::fmt; +pub mod prelude { + pub use { + apps::{ + AppBuilder, + Scopes + }, + registration::Registration + }; +} + /// Builder struct for defining your application. /// ``` -/// use elefren::apps::{AppBuilder, Scopes}; +/// use elefren::apps::prelude::*; /// /// let app = AppBuilder { /// client_name: "elefren_test", diff --git a/src/entities/itemsiter.rs b/src/entities/itemsiter.rs index d688be9..d791b00 100644 --- a/src/entities/itemsiter.rs +++ b/src/entities/itemsiter.rs @@ -5,7 +5,7 @@ use serde::Deserialize; /// /// ```no_run /// # extern crate elefren; -/// # use elefren::{Data, Mastodon, MastodonClient}; +/// # use elefren::prelude::*; /// # use std::error::Error; /// # fn main() -> Result<(), Box> { /// # let data = Data { diff --git a/src/lib.rs b/src/lib.rs index cc10f4b..91af1d6 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -9,8 +9,8 @@ //! # try().unwrap(); //! # } //! # fn try() -> elefren::Result<()> { -//! use elefren::{MastodonClient, Registration}; -//! use elefren::apps::{AppBuilder, Scopes}; +//! use elefren::prelude::*; +//! use elefren::apps::prelude::*; //! //! let app = AppBuilder { //! client_name: "elefren_test", @@ -74,7 +74,7 @@ pub mod requests; #[macro_use] mod macros; /// Automatically import the things you need pub mod prelude { - pub use {Mastodon, MastodonClient, StatusBuilder, StatusesRequest}; + pub use {Data, Mastodon, MastodonClient, StatusBuilder, StatusesRequest}; } /// Your mastodon application client, handles all requests to and from Mastodon. @@ -324,7 +324,7 @@ impl MastodonClient for Mastodon { /// /// ```no_run /// # extern crate elefren; - /// # use elefren::{Data, Mastodon, MastodonClient}; + /// # use elefren::prelude::*; /// # use std::error::Error; /// # fn main() -> Result<(), Box> { /// # let data = Data { @@ -342,7 +342,7 @@ impl MastodonClient for Mastodon { /// /// ```no_run /// # extern crate elefren; - /// # use elefren::{Data, Mastodon, MastodonClient, StatusesRequest}; + /// # use elefren::prelude::*; /// # use std::error::Error; /// # fn main() -> Result<(), Box> { /// # let data = Data { diff --git a/src/registration.rs b/src/registration.rs index df9ab77..a885de3 100644 --- a/src/registration.rs +++ b/src/registration.rs @@ -34,7 +34,7 @@ struct AccessToken { impl Registration { /// Construct a new registration process to the instance of the `base` url. /// ``` - /// use elefren::registration::Registration; + /// use elefren::apps::prelude::*; /// /// let registration = Registration::new("https://mastodon.social"); /// ``` @@ -57,8 +57,8 @@ impl Registration { /// # try().unwrap(); /// # } /// # fn try() -> elefren::Result<()> { - /// use elefren::{MastodonClient, Registration}; - /// use elefren::apps::{AppBuilder, Scopes}; + /// use elefren::prelude::*; + /// use elefren::apps::prelude::*; /// /// let app = AppBuilder { /// client_name: "elefren_test", diff --git a/src/status_builder.rs b/src/status_builder.rs index 3da8c91..fdfceff 100644 --- a/src/status_builder.rs +++ b/src/status_builder.rs @@ -41,7 +41,7 @@ impl StatusBuilder { /// Create a new status with text. /// ``` - /// use elefren::status_builder::StatusBuilder; + /// use elefren::prelude::*; /// /// let status = StatusBuilder::new("Hello World!".into()); /// ```