2 releases

0.0.2 May 15, 2024
0.0.1 May 14, 2024
0.0.0 Nov 19, 2023

#105 in HTTP server

Download history 12/week @ 2024-02-19 9/week @ 2024-03-11 7/week @ 2024-04-01 245/week @ 2024-05-13

245 downloads per month

MIT/Apache

585KB
17K SLoC

Argan

Crates.io Test status Documentation

A web framework for Rust.

Features

  • Static, regex, and wildcard URI component patterns.
  • Resource and handler extensions.
  • Request data extractors and support for custom guards.
  • Static file streaming with support for range requests, multipart/byteranges, pre-encoded files, and dynamic encoding.
  • Server-sent events.
  • WebSockets.
  • Flexible middleware system compatible with Tower.
  • Flexible error handling.

Usage example

Cargo.toml

[dependencies]
argan = { version = "0.0.1", features = ["json", "form"] }
hyper-util = { version = "0.1", features = ["server-auto", "tokio", "service"] }
serde = { version = "1", features = ["derive"] }
tokio = { version = "1", features = ["net", "rt-multi-thread", "macros"] }

main.rs

use std::net::SocketAddr;

use argan::{
	common::BoxedError,
	data::{form::Form, json::Json},
	handler::{_get, _post, _wildcard_method},
	request::RequestHead,
	response::Redirect,
	Router,
};

use hyper_util::{
	rt::{TokioExecutor, TokioIo},
	server::conn::auto as server,
};
use serde::{Deserialize, Serialize};
use tokio::net::TcpListener;

#[tokio::main]
async fn main() -> Result<(), BoxedError> {
	let mut router = Router::new();

	let root = router.resource_mut("http://www.example.com/");
	root.set_handler_for(_get.to(|| async { "Hello, World!" }));

	root.subresource_mut("/login").set_handler_for(_post.to(login));

	router
		.resource_mut("http://example.com/")
		.set_handler_for(_wildcard_method.to(Some(|head: RequestHead| async move {
			let path = head.uri_ref().path();

			Redirect::permanently_to(format!("http://www.example.com{}", path))
		})));

	let arc_service = router.into_arc_service();

	let addr = SocketAddr::from(([127, 0, 0, 1], 8000));
	let listener = TcpListener::bind(addr).await?;

	loop {
		let (stream, _) = listener.accept().await?;

		let io = TokioIo::new(stream);
		let arc_service = arc_service.clone();

		tokio::task::spawn(async move {
			let _ = server::Builder::new(TokioExecutor::new())
				.serve_connection(io, arc_service)
				.await;
		});
	}
}

async fn login(Form(_credential): Form<Credentials>) -> Json<Token> {
	// ...

	let token = Token {
		jwt: "JWT".to_owned(),
	};

	Json(token)
}

#[derive(Deserialize)]
struct Credentials {
	login: String,
	password: String,
}

#[derive(Serialize)]
struct Token {
	jwt: String,
}

Contributions

Pull requests are accepted on the dev branch.

Any contribution intentionally submitted for inclusion in Argan by you shall be dual licensed under the MIT License and Apache License, Version 2.0, like Argan, without any additional terms or conditions.

License

Argan is dual-licensed under either the MIT License or Apache License, Version 2.0, at your option.

Dependencies

~5–19MB
~224K SLoC