rework crate into a middleware

This changes the structure of the crate such that it is now a middleware in addition to being an extractor. Doing so allows us to improve the ergonomics of the API such that calling `save` and awaiting a future is no longer needed.

Now applications will need to install the `MeessagesManagerLayer` after `tower-sessions` has been installed (either directly or via a middleware that wraps it).

Also note that the iterator impplementation has been updated to use `Message` directly. Fields of `Message` have been made public as well.

Author: maxcountryman

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Unreleased
 
+# 0.2.0
+
+**Breaking Changes**
+
+- Rework crate into a middleware
+
+This changes the structure of the crate such that it is now a middleware in addition to being an extractor. Doing so allows us to improve the ergonomics of the API such that calling `save` and awaiting a future is no longer needed.
+
+Now applications will need to install the `MeessagesManagerLayer` after `tower-sessions` has been installed (either directly or via a middleware that wraps it).
+
+Also note that the iterator impplementation has been updated to use `Message` directly. Fields of `Message` have been made public as well.
+
 # 0.1.0
 
 - Initial release :tada:

Cargo.toml

@@ -1,12 +1,12 @@
 [package]
 name = "axum-messages"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 authors = ["Max Countryman <[email protected]>"]
 categories = ["asynchronous", "network-programming", "web-programming"]
 description = "🛎️ One-time notification messages for Axum."
 homepage = "https://github.com/maxcountryman/axum-messages"
-keywords = ["axum", "flash", "message", "messages"]
+keywords = ["axum", "flash", "message", "messages", "notification"]
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/maxcountryman/axum-messages"
@@ -15,7 +15,9 @@ repository = "https://github.com/maxcountryman/axum-messages"
 async-trait = "0.1.77"
 axum-core = "0.4.3"
 http = "1.0.0"
+parking_lot = "0.12.1"
 serde = { version = "1.0.195", features = ["derive"] }
+tower = "0.4"
 tower-sessions-core = "0.9.1"
 
 [dev-dependencies]

README.md

@@ -34,7 +34,7 @@ To use the crate in your project, add the following to your `Cargo.toml` file:
 
 ```toml
 [dependencies]
-axum-messages = "0.1.0"
+axum-messages = "0.2.0"
 ```
 
 ## 🤸 Usage
@@ -49,7 +49,7 @@ use axum::{
     routing::get,
     Router,
 };
-use axum_messages::Messages;
+use axum_messages::{Messages, MessagesManagerLayer};
 use time::Duration;
 use tower_sessions::{Expiry, MemoryStore, SessionManagerLayer};
 
@@ -63,6 +63,7 @@ async fn main() {
     let app = Router::new()
         .route("/", get(set_messages_handler))
         .route("/read-messages", get(read_messages_handler))
+        .layer(MessagesManagerLayer)
         .layer(session_layer);
 
     let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
@@ -75,7 +76,7 @@ async fn main() {
 async fn read_messages_handler(messages: Messages) -> impl IntoResponse {
     let messages = messages
         .into_iter()
-        .map(|(level, message)| format!("{:?}: {}", level, message))
+        .map(|message| format!("{:?}: {}", message.level, message))
         .collect::<Vec<_>>()
         .join(", ");
 
@@ -89,10 +90,7 @@ async fn read_messages_handler(messages: Messages) -> impl IntoResponse {
 async fn set_messages_handler(messages: Messages) -> impl IntoResponse {
     messages
         .info("Hello, world!")
-        .debug("This is a debug message.")
-        .save()
-        .await
-        .unwrap();
+        .debug("This is a debug message.");
 
     Redirect::to("/read-messages")
 }

examples/basic.rs

@@ -5,7 +5,7 @@ use axum::{
     routing::get,
     Router,
 };
-use axum_messages::Messages;
+use axum_messages::{Messages, MessagesManagerLayer};
 use time::Duration;
 use tower_sessions::{Expiry, MemoryStore, SessionManagerLayer};
 
@@ -19,6 +19,7 @@ async fn main() {
     let app = Router::new()
         .route("/", get(set_messages_handler))
         .route("/read-messages", get(read_messages_handler))
+        .layer(MessagesManagerLayer)
         .layer(session_layer);
 
     let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
@@ -31,7 +32,7 @@ async fn main() {
 async fn read_messages_handler(messages: Messages) -> impl IntoResponse {
     let messages = messages
         .into_iter()
-        .map(|(level, message)| format!("{:?}: {}", level, message))
+        .map(|message| format!("{:?}: {}", message.level, message))
         .collect::<Vec<_>>()
         .join(", ");
 
@@ -45,10 +46,7 @@ async fn read_messages_handler(messages: Messages) -> impl IntoResponse {
 async fn set_messages_handler(messages: Messages) -> impl IntoResponse {
     messages
         .info("Hello, world!")
-        .debug("This is a debug message.")
-        .save()
-        .await
-        .unwrap();
+        .debug("This is a debug message.");
 
     Redirect::to("/read-messages")
 }