Purge prelude

Signed-off-by: John Nunley <[email protected]>
smol-rs · Jan 15, 2024 · 30ef2ec · 30ef2ec
1 parent b5b8813
commit 30ef2ec
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 35 deletions.
diff --git a/benches/bench.rs b/benches/bench.rs
@@ -1,7 +1,7 @@
 use std::iter;
 
 use criterion::{criterion_group, criterion_main, Criterion};
-use event_listener::{prelude::*, Event};
+use event_listener::{Event, Listener};
 
 const COUNT: usize = 8000;
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -19,7 +19,7 @@
 //! use std::thread;
 //! use std::time::Duration;
 //! use std::usize;
-//! use event_listener::{Event, prelude::*};
+//! use event_listener::{Event, IntoNotification, Listener};
 //!
 //! let flag = Arc::new(AtomicBool::new(false));
 //! let event = Arc::new(Event::new());
@@ -106,11 +106,6 @@ use sync::{Arc, WithMut};
 use notify::{Internal, NotificationPrivate};
 pub use notify::{IntoNotification, Notification};
 
-/// Useful traits for notifications.
-pub mod prelude {
-    pub use crate::{IntoNotification, Listener, Notification};
-}
-
 /// Inner state of [`Event`].
 struct Inner<T> {
     /// The number of notified entries, or `usize::MAX` if all of them have been notified.
@@ -213,7 +208,7 @@ impl<T> Event<T> {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::<usize>::with_tag();
     /// ```
@@ -230,7 +225,7 @@ impl<T> Event<T> {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     /// let listener = event.listen();
@@ -254,7 +249,7 @@ impl<T> Event<T> {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     /// let listener = event.listen();
@@ -322,7 +317,7 @@ impl<T> Event<T> {
     /// Use the default notification strategy:
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     ///
@@ -346,7 +341,7 @@ impl<T> Event<T> {
     /// [`relaxed`]: IntoNotification::relaxed
     ///
     /// ```
-    /// use event_listener::{prelude::*, Event};
+    /// use event_listener::{IntoNotification, Listener, Event};
     /// use std::sync::atomic::{self, Ordering};
     ///
     /// let event = Event::new();
@@ -375,7 +370,7 @@ impl<T> Event<T> {
     /// [`additional`]: IntoNotification::additional
     ///
     /// ```
-    /// use event_listener::{prelude::*, Event};
+    /// use event_listener::{IntoNotification, Listener, Event};
     ///
     /// let event = Event::new();
     ///
@@ -398,7 +393,7 @@ impl<T> Event<T> {
     /// equivalent to calling [`Event::notify_additional_relaxed()`].
     ///
     /// ```
-    /// use event_listener::{prelude::*, Event};
+    /// use event_listener::{IntoNotification, Listener, Event};
     /// use std::sync::atomic::{self, Ordering};
     ///
     /// let event = Event::new();
@@ -495,7 +490,7 @@ impl Event<()> {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     /// ```
@@ -519,7 +514,7 @@ impl Event<()> {
     /// use [`Event::notify()`] like so:
     ///
     /// ```
-    /// use event_listener::{prelude::*, Event};
+    /// use event_listener::{IntoNotification, Listener, Event};
     /// let event = Event::new();
     ///
     /// // Old way:
@@ -532,7 +527,7 @@ impl Event<()> {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     /// use std::sync::atomic::{self, Ordering};
     ///
     /// let event = Event::new();
@@ -571,7 +566,7 @@ impl Event<()> {
     /// use [`Event::notify()`] like so:
     ///
     /// ```
-    /// use event_listener::{prelude::*, Event};
+    /// use event_listener::{IntoNotification, Listener, Event};
     /// let event = Event::new();
     ///
     /// // Old way:
@@ -584,7 +579,7 @@ impl Event<()> {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     ///
@@ -621,7 +616,7 @@ impl Event<()> {
     /// use [`Event::notify()`] like so:
     ///
     /// ```
-    /// use event_listener::{prelude::*, Event};
+    /// use event_listener::{IntoNotification, Listener, Event};
     /// let event = Event::new();
     ///
     /// // Old way:
@@ -634,7 +629,7 @@ impl Event<()> {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     /// use std::sync::atomic::{self, Ordering};
     ///
     /// let event = Event::new();
@@ -686,7 +681,7 @@ pub trait Listener<T = ()>: Future<Output = T> + __sealed::Sealed {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     /// let mut listener = event.listen();
@@ -708,7 +703,7 @@ pub trait Listener<T = ()>: Future<Output = T> + __sealed::Sealed {
     ///
     /// ```
     /// use std::time::Duration;
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     /// let mut listener = event.listen();
@@ -727,7 +722,7 @@ pub trait Listener<T = ()>: Future<Output = T> + __sealed::Sealed {
     ///
     /// ```
     /// use std::time::{Duration, Instant};
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     /// let mut listener = event.listen();
@@ -746,7 +741,7 @@ pub trait Listener<T = ()>: Future<Output = T> + __sealed::Sealed {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     /// let mut listener1 = event.listen();
@@ -764,7 +759,7 @@ pub trait Listener<T = ()>: Future<Output = T> + __sealed::Sealed {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     /// let listener = event.listen();
@@ -778,7 +773,7 @@ pub trait Listener<T = ()>: Future<Output = T> + __sealed::Sealed {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     /// let listener1 = event.listen();
@@ -932,7 +927,7 @@ forward_impl_to_listener! { T => EventListener<T> }
 /// use std::thread;
 /// use std::time::Duration;
 /// use std::usize;
-/// use event_listener::{Event, listener, prelude::*};
+/// use event_listener::{Event, listener, IntoNotification, Listener};
 ///
 /// let flag = Arc::new(AtomicBool::new(false));
 /// let event = Arc::new(Event::new());

diff --git a/src/notify.rs b/src/notify.rs
@@ -46,7 +46,7 @@ pub trait NotificationPrivate {
 /// # Example
 ///
 /// ```
-/// use event_listener::{Event, prelude::*};
+/// use event_listener::{Event, IntoNotification, Notification};
 ///
 /// fn notify(ev: &Event, notify: impl Notification<Tag = ()>) {
 ///     ev.notify(notify);
@@ -342,7 +342,7 @@ impl<T, F: FnMut() -> T> TagProducer for F {
 /// into this:
 ///
 /// ```
-/// use event_listener::{Event, prelude::*};
+/// use event_listener::{Event, IntoNotification, Listener};
 ///
 /// let event = Event::new();
 ///
@@ -380,7 +380,7 @@ pub trait IntoNotification: __private::Sealed {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::prelude::*;
+    /// use event_listener::IntoNotification;
     ///
     /// let _ = 3.into_notification();
     /// ```
@@ -406,7 +406,7 @@ pub trait IntoNotification: __private::Sealed {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     ///
     /// let event = Event::new();
     ///
@@ -442,7 +442,7 @@ pub trait IntoNotification: __private::Sealed {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{Event, prelude::*};
+    /// use event_listener::{Event, IntoNotification, Listener};
     /// use std::sync::atomic::{self, Ordering};
     ///
     /// let event = Event::new();
@@ -483,7 +483,7 @@ pub trait IntoNotification: __private::Sealed {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{prelude::*, Event};
+    /// use event_listener::{IntoNotification, Listener, Event};
     ///
     /// let event = Event::<bool>::with_tag();
     ///
@@ -517,7 +517,7 @@ pub trait IntoNotification: __private::Sealed {
     /// # Examples
     ///
     /// ```
-    /// use event_listener::{prelude::*, Event};
+    /// use event_listener::{IntoNotification, Listener, Event};
     ///
     /// let event = Event::<bool>::with_tag();
     ///