feat: v4.1.1

Author: eastspire

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tcplane"
-version = "4.1.0"
+version = "4.1.1"
 edition = "2024"
 authors = ["root@ltpp.vip"]
 license = "MIT"

src/common/type.rs

@@ -1,3 +1,6 @@
 use crate::*;
 
+/// A type alias for `Arc<RwLock<T>>`.
+///
+/// This type alias simplifies the use of `Arc<RwLock<T>>`, providing thread-safe shared ownership with read-write access.
 pub type ArcRwLock<T> = Arc<RwLock<T>>;

src/config/const.rs

@@ -1,9 +1,26 @@
+/// Default inner print setting.
 pub const DEFAULT_INNER_PRINT: bool = true;
+
+/// Default inner log setting.
 pub const DEFAULT_INNER_LOG: bool = true;
+
+/// Colon space separator string.
 pub const COLON_SPACE: &str = ": ";
+
+/// Colon space symbol string.
 pub const COLON_SPACE_SYMBOL: &str = ":";
+
+/// Default host address.
 pub const DEFAULT_HOST: &str = "0.0.0.0";
+
+/// Default listen port number.
 pub const DEFAULT_LISTEN_PORT: usize = 60000;
+
+/// Request split marker string.
 pub const SPLIT_REQUEST: &str = "\r\n\r\n";
+
+/// Request split marker bytes.
 pub const SPLIT_REQUEST_BYTES: &[u8] = SPLIT_REQUEST.as_bytes();
+
+/// Default buffer size for requests.
 pub const DEFAULT_BUFFER_SIZE: usize = 512_000;

src/config/impl.rs

@@ -1,5 +1,8 @@
 use crate::*;
 
+/// Implements default values for `ServerConfig`.
+///
+/// Provides a default server configuration with default host address, port, buffer size, and error handling function.
 impl Default for ServerConfig {
     fn default() -> Self {
         Self {

src/config/struct.rs

@@ -2,15 +2,15 @@ use crate::*;
 
 /// Server configuration parameters.
 ///
-/// Contains all necessary settings for server initialization and operation.
+/// Contains all settings required for server initialization and operation.
 #[derive(Clone)]
 pub struct ServerConfig {
-    /// Server host address.
+    /// The server host address.
     pub(crate) host: String,
-    /// Server listening port.
+    /// The server listening port.
     pub(crate) port: usize,
     /// Network buffer size in bytes.
     pub(crate) buffer_size: usize,
-    /// Error handler for server operations.
+    /// Error handling function for server operations.
     pub(crate) error_handle: ArcErrorHandle,
 }

src/config/type.rs

@@ -1,3 +1,4 @@
 use crate::*;
 
+/// A type alias for `Arc<RwLock<ServerConfig>>`.
 pub type ArcRwLockServerConfig = ArcRwLock<ServerConfig>;

src/context/impl.rs

@@ -1,6 +1,12 @@
 use crate::*;
 
+/// Manages the internal state of the context.
 impl InnerContext {
+    /// Creates a new `InnerContext` with default values.
+    ///
+    /// # Returns
+    ///
+    /// - `InnerContext` - A new instance of `InnerContext`.
     pub fn new() -> Self {
         InnerContext {
             stream: None,
@@ -11,40 +17,123 @@ impl InnerContext {
     }
 }
 
+/// Provides thread-safe access and manipulation of the context.
 impl Context {
+    /// Creates a `Context` from an `InnerContext`.
+    ///
+    /// # Arguments
+    ///
+    /// - `InnerContext` - The inner context to wrap.
+    ///
+    /// # Returns
+    ///
+    /// - `Self` - A new `Context` instance.
     pub(crate) fn from_inner_context(ctx: InnerContext) -> Self {
         Self(Arc::new(RwLock::new(ctx)))
     }
 
+    /// Gets a read lock for the inner context.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `RwLockReadContext` - A read guard for the inner context.
     pub async fn get_read_lock(&self) -> RwLockReadContext {
         self.0.read().await
     }
 
+    /// Gets a write lock for the inner context.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `RwLockWriteContext` - A write guard for the inner context.
     pub async fn get_write_lock(&self) -> RwLockWriteContext {
         self.0.write().await
     }
 
+    /// Gets a clone of the inner context.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `InnerContext` - A cloned inner context.
     pub async fn get(&self) -> InnerContext {
         self.get_read_lock().await.clone()
     }
 
+    /// Gets the stream from the inner context.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `OptionArcRwLockStream` - The optional stream.
     pub async fn get_stream(&self) -> OptionArcRwLockStream {
         self.get().await.stream.clone()
     }
 
+    /// Gets the request from the inner context.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `Request` - The request object.
     pub async fn get_request(&self) -> Request {
         self.get().await.request.clone()
     }
 
+    /// Gets the response from the inner context.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `Response` - The response object.
     pub async fn get_response(&self) -> Response {
         self.get().await.response.clone()
     }
 
+    /// Sets response data.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    /// - `data` - The data to set, which can be converted into `ResponseData`.
+    ///
+    /// # Returns
+    ///
+    /// - `&Self` - A reference to the `Context`.
     pub(super) async fn set_response_data<T: Into<ResponseData>>(&self, data: T) -> &Self {
         self.get_write_lock().await.response.set_response_data(data);
         self
     }
 
+    /// Gets the socket address from the stream.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `OptionSocketAddr` - The optional socket address.
     pub async fn get_socket_addr(&self) -> OptionSocketAddr {
         let stream_result: OptionArcRwLockStream = self.get_stream().await;
         if stream_result.is_none() {
@@ -59,6 +148,15 @@ impl Context {
         socket_addr_opt
     }
 
+    /// Gets the socket address or a default if none is available.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `SocketAddr` - The socket address or the default socket address.
     pub async fn get_socket_addr_or_default(&self) -> SocketAddr {
         let stream_result: OptionArcRwLockStream = self.get_stream().await;
         if stream_result.is_none() {
@@ -73,26 +171,72 @@ impl Context {
         socket_addr
     }
 
+    /// Gets the socket address as a string.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `Option<String>` - The socket address as a string, if available.
     pub async fn get_socket_addr_string(&self) -> Option<String> {
         self.get_socket_addr().await.map(|data| data.to_string())
     }
 
+    /// Gets the socket address as a string, or a default string if none is available.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `String` - The socket address as a string, or the default socket address string.
     pub async fn get_socket_addr_or_default_string(&self) -> String {
         self.get_socket_addr_or_default().await.to_string()
     }
 
+    /// Gets the socket host from the socket address.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `OptionSocketHost` - The optional socket host.
     pub async fn get_socket_host(&self) -> OptionSocketHost {
         self.get_socket_addr()
             .await
             .map(|socket_addr: SocketAddr| socket_addr.ip())
     }
 
+    /// Gets the socket port from the socket address.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `OptionSocketPort` - The optional socket port.
     pub async fn get_socket_port(&self) -> OptionSocketPort {
         self.get_socket_addr()
             .await
             .map(|socket_addr: SocketAddr| socket_addr.port())
     }
 
+    /// Sends data through the stream.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    /// - `data` - The data to send, which can be converted into `ResponseData`.
+    ///
+    /// # Returns
+    ///
+    /// - `ResponseResult` - Ok(()) on success, or an error if the stream is not found or sending fails.
     pub async fn send<T: Into<ResponseData>>(&self, data: T) -> ResponseResult {
         if let Some(stream) = self.get_stream().await {
             self.set_response_data(data)
@@ -106,6 +250,15 @@ impl Context {
         Err(ResponseError::NotFoundStream)
     }
 
+    /// Closes the stream.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `ResponseResult` - Ok(()) on success, or an error if the stream is not found or closing fails.
     pub async fn close(&self) -> ResponseResult {
         if let Some(stream) = self.get_stream().await {
             self.get_response().await.close(&stream).await?;
@@ -114,6 +267,15 @@ impl Context {
         Err(ResponseError::NotFoundStream)
     }
 
+    /// Flushes the stream.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `ResponseResult` - Ok(()) on success, or an error if the stream is not found or flushing fails.
     pub async fn flush(&self) -> ResponseResult {
         if let Some(stream) = self.get_stream().await {
             self.get_response().await.flush(&stream).await?;
@@ -122,6 +284,17 @@ impl Context {
         Err(ResponseError::NotFoundStream)
     }
 
+    /// Sets a data value in the context's data map.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    /// - `key` - The key for the data.
+    /// - `value` - The value to set, which must be cloneable and thread-safe.
+    ///
+    /// # Returns
+    ///
+    /// - `&Self` - A reference to the `Context`.
     pub async fn set_data_value<T: Any + Send + Sync + Clone>(
         &self,
         key: &str,
@@ -134,6 +307,16 @@ impl Context {
         self
     }
 
+    /// Gets a data value from the context's data map.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    /// - `key` - The key for the data.
+    ///
+    /// # Returns
+    ///
+    /// - `Option<T>` - The data value if found and successfully downcasted, otherwise `None`.
     pub async fn get_data_value<T: Any + Send + Sync + Clone>(&self, key: &str) -> Option<T> {
         self.get_read_lock()
             .await
@@ -143,11 +326,30 @@ impl Context {
             .cloned()
     }
 
+    /// Removes a data value from the context's data map.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    /// - `key` - The key of the data to remove.
+    ///
+    /// # Returns
+    ///
+    /// - `&Self` - A reference to the `Context`.
     pub async fn remove_data_value(&self, key: &str) -> &Self {
         self.get_write_lock().await.data.remove(key);
         self
     }
 
+    /// Clears all data from the context's data map.
+    ///
+    /// # Arguments
+    ///
+    /// - `&self` - A reference to the `Context`.
+    ///
+    /// # Returns
+    ///
+    /// - `&Self` - A reference to the `Context`.
     pub async fn clear_data(&self) -> &Self {
         self.get_write_lock().await.data.clear();
         self