hyperlane
Official Documentation
Api Docs
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.
Installation
To use this crate, you can run cmd:
cargo add hyperlane
Quick start
git clone https://github.com/hyperlane-dev/hyperlane-quick-start.git
Use
use hyperlane::*;
async fn connected_hook(ctx: Context) {
if !ctx.get_request().await.is_ws() {
return;
}
let socket_addr: String = ctx.get_socket_addr_or_default_string().await;
let _ = ctx.set_response_body(socket_addr).await.send_body().await;
}
async fn request_middleware(ctx: Context) {
let socket_addr: String = ctx.get_socket_addr_or_default_string().await;
ctx.set_response_version(HttpVersion::HTTP1_1)
.await
.set_response_status_code(200)
.await
.set_response_header(SERVER, HYPERLANE)
.await
.set_response_header(CONNECTION, KEEP_ALIVE)
.await
.set_response_header(CONTENT_TYPE, TEXT_PLAIN)
.await
.set_response_header("SocketAddr", socket_addr)
.await;
}
async fn response_middleware(ctx: Context) {
if ctx.get_request().await.is_ws() {
return;
}
let _ = ctx.send().await;
}
async fn root_route(ctx: Context) {
let path: RequestPath = ctx.get_request_path().await;
let response_body: String = format!("Hello hyperlane => {}", path);
let cookie1: String = CookieBuilder::new("key1", "value1").http_only().build();
let cookie2: String = CookieBuilder::new("key2", "value2").http_only().build();
ctx.set_response_status_code(200)
.await
.set_response_header(SET_COOKIE, cookie1)
.await
.set_response_header(SET_COOKIE, cookie2)
.await
.set_response_body(response_body)
.await;
}
async fn ws_route(ctx: Context) {
let key: RequestHeadersValueItem = ctx
.get_request_header_back(SEC_WEBSOCKET_KEY)
.await
.unwrap_or_default();
let request_body: Vec<u8> = ctx.get_request_body().await;
let _ = ctx.set_response_body(key).await.send_body().await;
let _ = ctx.set_response_body(request_body).await.send_body().await;
}
async fn sse_route(ctx: Context) {
let _ = ctx
.set_response_header(CONTENT_TYPE, TEXT_EVENT_STREAM)
.await
.send()
.await;
for i in 0..10 {
let _ = ctx
.set_response_body(format!("data:{}{}", i, HTTP_DOUBLE_BR))
.await
.send_body()
.await;
}
let _ = ctx.closed().await;
}
async fn dynamic_route(ctx: Context) {
let param: RouteParams = ctx.get_route_params().await;
panic!("Test panic {:?}", param);
}
async fn panic_hook(ctx: Context) {
let error: Panic = ctx.get_panic().await.unwrap_or_default();
let response_body: String = error.to_string();
eprintln!("{}", response_body);
let _ = std::io::Write::flush(&mut std::io::stderr());
let content_type: String = ContentType::format_content_type_with_charset(TEXT_PLAIN, UTF8);
let _ = ctx
.set_response_version(HttpVersion::HTTP1_1)
.await
.set_response_status_code(500)
.await
.clear_response_headers()
.await
.set_response_header(SERVER, HYPERLANE)
.await
.set_response_header(CONTENT_TYPE, content_type)
.await
.set_response_body(response_body)
.await
.send()
.await;
}
#[tokio::main]
async fn main() {
let config: ServerConfig = ServerConfig::new();
config.host("0.0.0.0").await;
config.port(60000).await;
config.enable_nodelay().await;
config.http_buffer(4096).await;
config.ws_buffer(4096).await;
let server: Server = Server::from(config).await;
server.panic_hook(panic_hook).await;
server.connected_hook(connected_hook).await;
server.pre_upgrade_hook(request_middleware).await;
server.request_middleware(request_middleware).await;
server.response_middleware(response_middleware).await;
server.route("/", root_route).await;
server.route("/ws", ws_route).await;
server.route("/sse", sse_route).await;
server.route("/dynamic/{routing}", dynamic_route).await;
server.route("/regex/{file:^.*$}", dynamic_route).await;
let server_hook: ServerHook = server.run().await.unwrap_or_default();
server_hook.wait().await;
}
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
Contact
For any inquiries, please reach out to the author at root@ltpp.vip.
