via 2.0.0-gm.7

mod error;
mod message;
mod upgrade;

pub use error::{Result, ResultExt};
pub use message::{Channel, CloseCode, Message};
pub use upgrade::{Request, Upgrade};

/// Upgrade the connection to a web socket.
///
/// # Example
///
/// ```
/// use via::ws::{self, Channel, Message, Request};
/// use via::{Error, Payload};
///
/// async fn echo(mut channel: Channel, _: Request) -> ws::Result {
///     loop {
///         let Some(message) = channel.recv().await else {
///             break Ok(());
///         };
///
///         if let Message::Close(close) = &message {
///             close.as_ref().inspect(|(code, reason)| {
///                 eprintln!("{:?}: {:?}", code, reason);
///             });
///
///             break Ok(());
///         }
///
///         channel.send(message).await?;
///     }
/// }
///
/// #[tokio::main]
/// async fn main() -> Result<(), Error> {
///     let mut app = via::app(());
///
///     // GET /echo ~> web socket upgrade.
///     app.route("/echo").to(ws::upgrade(echo));
///
///     Ok(())
/// }
///```
///
pub fn upgrade<App, F, R>(upgraded: F) -> Upgrade<F>
where
    F: Fn(Channel, Request<App>) -> R + Send + Sync + 'static,
    R: Future<Output = Result> + Send,
{
    Upgrade::new(upgraded)
}