tcplane 8.1.0

tcplane is a lightweight and high-performance Rust TCP server library designed to simplify network service development. It supports TCP communication, data stream management, and connection handling, focusing on providing efficient low-level network connections and data transmission capabilities, making it ideal for building modern network services.
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
74
75
76
77
78
79
80
81

use crate::*;

/// Trait for server lifecycle hooks that process connections.
///
/// `ServerHook` provides a unified interface for different types of connection
/// processing handlers in the server lifecycle.
///
/// This trait is designed to work with the server's connection processing pipeline.
pub trait ServerHook: Send + Sync + 'static {
    /// Creates a new instance of this hook from the context.
    ///
    /// This method is called by the framework to instantiate the hook.
    ///
    /// # Arguments
    ///
    /// - `&Context` - The connection context containing all request/response data.
    ///
    /// # Returns
    ///
    /// A future that resolves to a new instance of this hook.
    fn new(ctx: &Context) -> impl Future<Output = Self> + Send;

    /// Executes the hook's processing logic.
    ///
    /// This method contains the actual logic for processing the connection.
    ///
    /// # Arguments
    ///
    /// - `&Context` - The connection context for accessing request/response data.
    ///
    /// # Returns
    ///
    /// A future that resolves when the processing is complete.
    fn handle(self, ctx: &Context) -> impl Future<Output = ()> + Send;
}

/// Trait for async function handlers.
///
/// This trait is used for handlers that return a future directly.
pub trait AsyncFuncWithoutPin<Fut>: Fn(Context) -> Fut + Send + Sync + 'static
where
    Fut: Future<Output = ()> + Send + 'static,
{
}

/// Blanket implementation for all types implementing the required bounds.
impl<T, Fut> AsyncFuncWithoutPin<Fut> for T
where
    T: Fn(Context) -> Fut + Send + Sync + 'static,
    Fut: Future<Output = ()> + Send + 'static,
{
}

/// A default no-op hook implementation.
///
/// This struct can be used as a placeholder or base for custom hooks.
#[derive(Clone, Copy, Debug)]
pub struct DefaultHook;

/// Implementation of `ServerHook` for `DefaultHook`.
impl ServerHook for DefaultHook {
    /// Creates a new `DefaultHook` instance.
    ///
    /// # Arguments
    ///
    /// - `&Context` - The context (unused).
    ///
    /// # Returns
    ///
    /// - `Self` - A new instance of `DefaultHook`.
    async fn new(_: &Context) -> Self {
        Self
    }

    /// Handles the hook execution (no-op).
    ///
    /// # Arguments
    ///
    /// - `&Context` - The context (unused).
    async fn handle(self, _: &Context) {}
}