Add constructor to Sse (#244)

I think this is more consistent with the rest of the API

examples/sse/src/main.rs

@@ -8,7 +8,7 @@ use axum::{
     extract::TypedHeader,
     handler::get,
     http::StatusCode,
-    response::sse::{sse, Event, Sse},
+    response::sse::{Event, Sse},
     Router,
 };
 use futures::stream::{self, Stream};
@@ -59,5 +59,5 @@ async fn sse_handler(
         .map(Ok)
         .throttle(Duration::from_secs(1));
 
-    sse(stream)
+    Sse::new(stream)
 }

src/response/mod.rs

@@ -21,11 +21,7 @@ pub mod sse;
 pub use crate::Json;
 
 #[doc(inline)]
-pub use self::{
+pub use self::{headers::Headers, redirect::Redirect, sse::Sse};
-    headers::Headers,
-    redirect::Redirect,
-    sse::{sse, Sse},
-};
 
 /// Trait for generating responses.
 ///

src/response/sse.rs

@@ -4,10 +4,10 @@
 //!
 //! ```
 //! use axum::{
-//!     handler::get,
 //!     Router,
+//!     handler::get,
+//!     response::sse::{Event, KeepAlive, Sse},
 //! };
-//! use axum::response::sse::{sse, Event, KeepAlive, Sse};
 //! use std::{time::Duration, convert::Infallible};
 //! use tokio_stream::StreamExt as _ ;
 //! use futures::stream::{self, Stream};
@@ -20,7 +20,7 @@
 //!         .map(Ok)
 //!         .throttle(Duration::from_secs(1));
 //!
-//!     sse(stream).keep_alive(KeepAlive::default())
+//!     Sse::new(stream).keep_alive(KeepAlive::default())
 //! }
 //! # async {
 //! # hyper::Server::bind(&"".parse().unwrap()).serve(app.into_make_service()).await.unwrap();
@@ -50,22 +50,7 @@ use std::{
 use sync_wrapper::SyncWrapper;
 use tokio::time::Sleep;
 
-/// Create a new [`Sse`] response that will respond with the given stream of
+/// An SSE response
-/// [`Event`]s.
-///
-/// See the [module docs](self) for more details.
-pub fn sse<S>(stream: S) -> Sse<S>
-where
-    S: TryStream<Ok = Event> + Send + 'static,
-    S::Error: Into<BoxError>,
-{
-    Sse {
-        stream,
-        keep_alive: None,
-    }
-}
-
-/// An SSE response, created by [`sse`].
 #[derive(Clone)]
 pub struct Sse<S> {
     stream: S,
@@ -73,6 +58,21 @@ pub struct Sse<S> {
 }
 
 impl<S> Sse<S> {
+    /// Create a new [`Sse`] response that will respond with the given stream of
+    /// [`Event`]s.
+    ///
+    /// See the [module docs](self) for more details.
+    pub fn new(stream: S) -> Self
+    where
+        S: TryStream<Ok = Event> + Send + 'static,
+        S::Error: Into<BoxError>,
+    {
+        Sse {
+            stream,
+            keep_alive: None,
+        }
+    }
+
     /// Configure the interval between keep-alive messages.
     ///
     /// Defaults to no keep-alive messages.