deboa-extras 0.0.9-beta.11

deboa extras (serialization, compression, websockets, streams, catchers (middleware) and sse support).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

use std::future::Future;

use crate::ws::io::socket::{DeboaWebSocket, UpgradedIo, WebSocket};
use deboa::{response::DeboaResponse, Result};

/// Trait for converting a DeboaResponse into a WebSocket
pub trait IntoWebSocket {
    /// Converts a DeboaResponse into a WebSocket
    ///
    /// # Arguments
    ///
    /// * `self` - The DeboaResponse to convert
    ///
    /// # Returns
    ///
    /// A Result containing the WebSocket
    ///
    /// # Example
    ///
    /// ``` compile_fail
    /// use deboa::{Client, Result, request::{IntoUrl, DeboaRequestBuilder}};
    /// use deboa_extras::http::ws::request::{WebsocketRequestBuilder};
    ///
    /// let mut client = Client::new();
    /// let builder = DeboaRequestBuilder::websocket("ws://example.com").unwrap();
    /// let response = builder
    ///     .send_with(&mut client)
    ///     .await
    ///     .unwrap();
    /// let websocket = response.into_websocket().unwrap();
    ///
    /// loop {
    ///     if let Ok(Some(message)) = websocket.read_message().await {
    ///         println!("message: {}", message);
    ///     }
    /// }
    /// ```
    fn into_websocket(self) -> impl Future<Output = Result<WebSocket<UpgradedIo>>>;
}

impl IntoWebSocket for DeboaResponse {
    async fn into_websocket(self) -> Result<WebSocket<UpgradedIo>> {
        let upgraded = self
            .upgrade()
            .await?;
        Ok(WebSocket::new(upgraded))
    }
}