udp 3.1.0

A lightweight and efficient Rust library for building UDP servers with request-response handling.
Documentation 
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

use crate::*;

/// Default implementation for Response.
impl Default for Response {
    /// Creates a default empty response.
    ///
    /// # Returns
    ///
    /// - `Response` - New response with empty data.
    #[inline(always)]
    fn default() -> Self {
        Self { data: Vec::new() }
    }
}

/// Implementation of Response methods.
impl Response {
    /// Creates a Response from convertible data.
    ///
    /// # Arguments
    ///
    /// - `Into<ResponseData>` - Data convertible to ResponseData.
    ///
    /// # Returns
    ///
    /// - `Response` - New response containing the data.
    #[inline(always)]
    pub fn from<T>(data: T) -> Self
    where
        T: Into<ResponseData>,
    {
        Self { data: data.into() }
    }

    /// Gets the underlying response data.
    ///
    /// # Returns
    ///
    /// - `&ResponseData` - Reference to the response data.
    pub fn get_data(&self) -> &ResponseData {
        &self.data
    }

    /// Sends the response through the specified socket.
    ///
    /// # Arguments
    ///
    /// - `&Option<ArcRwLockUdpSocket>` - Optional socket reference.
    /// - `&Option<SocketAddr>` - Optional target address.
    ///
    /// # Returns
    ///
    /// - `ResponseResult` - Result of the send operation.
    pub async fn send(
        &self,
        socket_opt: &Option<ArcRwLockUdpSocket>,
        addr_opt: &Option<SocketAddr>,
    ) -> ResponseResult {
        if let Some(socket_lock) = socket_opt {
            let socket: tokio::sync::RwLockReadGuard<'_, UdpSocket> =
                socket_lock.get_read_lock().await;
            if let Some(addr) = addr_opt {
                socket
                    .send_to(self.get_data(), addr)
                    .await
                    .map_err(|e| ResponseError::SendError(e.to_string()))?;
                return Ok(());
            }
            return Err(ResponseError::AddressNotAvailable);
        }
        Err(ResponseError::SocketNotAvailable)
    }
}