hyperlane-quick-start 13.1.0

A lightweight rust http server with middleware, websocket, sse, and tcp support, built on tokio for cross-platform async networking, hyperlane simplifies modern web service development.
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

<center>

## hyperlane-quick-start

<img src="https://docs.ltpp.vip/img/hyperlane.png" alt="" height="160">

[![](https://img.shields.io/crates/v/hyperlane.svg)](https://crates.io/crates/hyperlane)
[![](https://img.shields.io/crates/d/hyperlane.svg)](https://img.shields.io/crates/d/hyperlane.svg)
[![](https://docs.rs/hyperlane/badge.svg)](https://docs.rs/hyperlane)
[![](https://github.com/hyperlane-dev/hyperlane/workflows/Rust/badge.svg)](https://github.com/hyperlane-dev/hyperlane/actions?query=workflow:Rust)
[![](https://img.shields.io/crates/l/hyperlane.svg)](./license)

</center>

> A lightweight, high-performance, and cross-platform Rust HTTP server library built on Tokio. It simplifies modern web service development by providing built-in support for middleware, WebSocket, Server-Sent Events (SSE), and raw TCP communication. With a unified and ergonomic API across Windows, Linux, and MacOS, it enables developers to build robust, scalable, and event-driven network applications with minimal overhead and maximum flexibility.

## Official Documentation

- [Official Documentation](https://docs.ltpp.vip/hyperlane/)

## Api Docs

- [Api Docs](https://docs.rs/hyperlane/latest/)

## Directory Structure

```txt
├── app                      # Application service
│   ├── controller           # Interface control layer
│   ├── domain               # Business domain layer
│   ├── exception            # Exception handling layer
│      ├── application       # Application exceptions
│      ├── framework         # Framework exceptions
│   ├── mapper               # Data mapping layer
│   ├── middleware           # Middleware layer
│   ├── model                # Data model layer
│      ├── request           # Request parameter objects
│      ├── response          # Response parameter objects
│   ├── repository           # Data access layer
│   ├── service              # Business logic layer
│   ├── utils                # Utility layer
│   ├── view                 # View layer
├── config                   # Service configuration
│   ├── application          # Application configuration
│   ├── framework            # Framework configuration
├── init                     # Service initialization
│   ├── application          # Application initialization
│   ├── framework            # Framework initialization
├── plugin                   # Service plugins
│   ├── database             # Database plugin
│   ├── env                  # Environment variable plugin
│   ├── logger               # Logging plugin
│   ├── mysql                # MySQL plugin
│   ├── postgresql           # PostgreSQL plugin
│   ├── process              # Process management plugin
│   ├── redis                # Redis plugin
├── resources                # Service resources
│   ├── sql                  # SQL files
│   ├── static               # Static resource files
│   ├── templates            # Template files
```

## Run

### start

```sh
cargo run
```

### hot-restart

```sh
cargo run hot-restart
```

### started in background

```sh
cargo run -- -d
```

### stop

```sh
cargo run stop
```

### restart

```sh
cargo run restart
```

### restarted in background

```sh
cargo run restart -d
```

### fmt-derive

```sh
cargo run fmt-derive
```

### fmt

```sh
cargo run fmt
```

## Performance

- [Performance](https://docs.ltpp.vip/hyperlane/speed)

## Appreciate

> If you feel that `hyperlane` is helpful to you, feel free to donate

### WeChat Pay

<img src="https://docs.ltpp.vip/img/wechatpay.png" width="200">

### Alipay

<img src="https://docs.ltpp.vip/img/alipay.png" width="200">

### Virtual Currency Pay

| Virtual Currency | Virtual Currency Address                   |
| ---------------- | ------------------------------------------ |
| BTC              | 3QndxCJTf3mEniTgyRRQ1jcNTJajm9qSCy         |
| ETH              | 0x8EB3794f67897ED397584d3a1248a79e0B8e97A6 |
| BSC              | 0x8EB3794f67897ED397584d3a1248a79e0B8e97A6 |

## License

This project is licensed under the MIT License. For more details, please see the [license](license) file.

## Contributing

Contributions are welcome! Please submit an issue or create a pull request.

## Contact

If you have any questions, please contact the author: [root@ltpp.vip](mailto:root@ltpp.vip).