feat: v0.3.0

Author: eastspire

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "udp-request"
-version = "0.2.10"
+version = "0.3.0"
 edition = "2024"
 authors = ["root@ltpp.vip"]
 license = "MIT"

src/lib.rs

@@ -1,3 +1,8 @@
+//! udp-request
+//!
+//! A simple UDP request library for sending and receiving UDP packets,
+//! designed to handle network communication in Rust applications.
+
 #[cfg(test)]
 mod cfg;
 pub(crate) mod common;

src/request/config/impl.rs

@@ -1,6 +1,12 @@
 use crate::*;
 
+/// Default implementation for Config.
 impl Default for Config {
+    /// Creates a default Config instance.
+    ///
+    /// # Returns
+    ///
+    /// - `Config` - Default configuration with empty host, default port, timeout and buffer size.
     fn default() -> Self {
         Self {
             timeout: DEFAULT_TIMEOUT,

src/request/config/struct.rs

@@ -1,9 +1,16 @@
 use crate::*;
 
+/// Configuration for UDP request.
+///
+/// Contains network settings and timeout configurations.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Config {
+    /// Remote host address.
     pub(crate) host: String,
+    /// Remote port number.
     pub(crate) port: usize,
+    /// Request timeout in milliseconds.
     pub(crate) timeout: u64,
+    /// Buffer size for receiving data.
     pub(crate) buffer_size: usize,
 }

src/request/error/enum.rs

@@ -1,12 +1,22 @@
+/// Error types for UDP requests.
 #[derive(Debug)]
 pub enum RequestError {
+    /// Invalid URL format.
     InvalidUrl,
+    /// Failed to create UDP socket.
     UdpSocketCreateError,
+    /// Failed to connect UDP socket.
     UdpSocketConnectError,
+    /// General request error.
     RequestError,
+    /// Failed to read from connection.
     ReadConnectionError,
+    /// Failed to set read timeout.
     SetReadTimeoutError,
+    /// Failed to set write timeout.
     SetWriteTimeoutError,
+    /// Failed to read response.
     ReadResponseError,
+    /// Failed to send response with error message.
     SendResponseError(String),
 }

src/request/request/impl.rs

@@ -1,6 +1,12 @@
 use crate::*;
 
+/// Default implementation for UdpRequest.
 impl Default for UdpRequest {
+    /// Creates a default UdpRequest instance.
+    ///
+    /// # Returns
+    ///
+    /// - `UdpRequest` - Default request with default config and empty response.
     fn default() -> Self {
         Self {
             config: Arc::new(RwLock::new(Config::default())),
@@ -10,6 +16,16 @@ impl Default for UdpRequest {
 }
 
 impl UdpRequest {
+    /// Sends UDP request data through socket.
+    ///
+    /// # Arguments
+    ///
+    /// - `&mut UdpSocket` - UDP socket for communication.
+    /// - `&[u8]` - Data to send.
+    ///
+    /// # Returns
+    ///
+    /// - `Result<BoxResponseTrait, RequestError>` - Response or error.
     fn send_request(
         &mut self,
         socket: &mut UdpSocket,
@@ -21,6 +37,15 @@ impl UdpRequest {
         self.read_response(socket)
     }
 
+    /// Reads response from UDP socket.
+    ///
+    /// # Arguments
+    ///
+    /// - `&mut UdpSocket` - UDP socket for communication.
+    ///
+    /// # Returns
+    ///
+    /// - `Result<BoxResponseTrait, RequestError>` - Response or error.
     fn read_response(&mut self, socket: &mut UdpSocket) -> Result<BoxResponseTrait, RequestError> {
         let cfg_buffer_size: usize = self
             .config
@@ -39,6 +64,16 @@ impl UdpRequest {
         ));
     }
 
+    /// Creates and configures UDP socket for connection.
+    ///
+    /// # Arguments
+    ///
+    /// - `String` - Host address.
+    /// - `usize` - Port number.
+    ///
+    /// # Returns
+    ///
+    /// - `Result<UdpSocket, RequestError>` - Configured socket or error.
     fn get_connection_socket(&self, host: String, port: usize) -> Result<UdpSocket, RequestError> {
         let host_port: String = format!("{}:{}", host.clone(), port);
         let cfg_timeout: u64 = self
@@ -62,9 +97,19 @@ impl UdpRequest {
     }
 }
 
+/// RequestTrait implementation for UdpRequest.
 impl RequestTrait for UdpRequest {
     type RequestResult = RequestResult;
 
+    /// Sends UDP request with given data.
+    ///
+    /// # Arguments
+    ///
+    /// - `&[u8]` - Data to send.
+    ///
+    /// # Returns
+    ///
+    /// - `RequestResult` - Response or error.
     fn send(&mut self, data: &[u8]) -> Self::RequestResult {
         let cfg_timeout: Config = self
             .config

src/request/trait.rs

@@ -1,7 +1,18 @@
 use crate::*;
 
+/// Trait for UDP request operations.
 pub trait RequestTrait: Send + Debug {
+    /// Associated result type for request operations.
     type RequestResult: Sized;
 
+    /// Sends data through the request.
+    ///
+    /// # Arguments
+    ///
+    /// - `&[u8]` - Data to send.
+    ///
+    /// # Returns
+    ///
+    /// - `Self::RequestResult` - Result of the send operation.
     fn send(&mut self, data: &[u8]) -> Self::RequestResult;
 }

src/request/type.rs

@@ -1,4 +1,11 @@
 use crate::*;
 
+/// Result type for UDP requests.
+///
+/// Contains either a boxed response trait object or request error.
 pub type RequestResult = Result<BoxResponseTrait, RequestError>;
+
+/// Boxed trait object for UDP request.
+///
+/// Used to store different request implementations.
 pub type BoxRequestTrait = Box<dyn RequestTrait<RequestResult = RequestResult>>;

src/response/response_binary/impl.rs

@@ -1,20 +1,40 @@
 use crate::*;
 
+/// ResponseTrait implementation for binary UDP response.
 impl ResponseTrait for UdpResponseBinary {
     type OutputText = UdpResponseText;
     type OutputBinary = UdpResponseBinary;
 
+    /// Creates UdpResponseBinary from byte slice.
+    ///
+    /// # Arguments
+    ///
+    /// - `&[u8]` - Response data.
+    ///
+    /// # Returns
+    ///
+    /// - `Self` - New binary response instance.
     fn from(response: &[u8]) -> Self
     where
         Self: Sized,
     {
         response.to_vec()
     }
 
+    /// Gets binary representation of response.
+    ///
+    /// # Returns
+    ///
+    /// - `Self::OutputBinary` - Binary response data.
     fn binary(&self) -> Self::OutputBinary {
         self.clone()
     }
 
+    /// Converts binary response to text representation.
+    ///
+    /// # Returns
+    ///
+    /// - `UdpResponseText` - Text response data.
     fn text(&self) -> UdpResponseText {
         let data: String = String::from_utf8_lossy(&self).to_string();
         data

src/response/response_binary/type.rs

@@ -1 +1,4 @@
+/// Binary response type for UDP operations.
+///
+/// Represents raw binary data received from UDP requests.
 pub type UdpResponseBinary = Vec<u8>;