tela 0.1.0

Web framework that focuses on ease of use and simplicity
Documentation

Tela

Rust based web design :smile:

Construct endpoints or error handlers like so.

use tela::prelude::*;
// This is a text/plain response
#[get("/")]
fn home() -> &'static str {
  "Hello, world!"
}

use tela::{prelude::*, response::HTML};
// This is a text/html response that could fail and the error should be either
// given to the appropriate handler or returned as is.
#[post("/login/:username/:age")]
fn data(username: String, age: i32) -> Result<HTML<String>> {
  response!(html!(<h1>"Hello, world!"</h1>))
}

use tela::{prelude::*, response::HTML};
// Catches any error that is 404 comming from another endpoint
// soon this will be for all 404 errors that are thrown
// All returns must be valid data. There can not be custom HTTP codes or results
// returned.
#[catch(404)]
fn not_found(code: u16, message: String, reason: String) -> HTML<String> {
  html!(<h1>{code}" "{message}</h1>)
}

use tela::{prelude::*, response::{JSON, Raw}};
// Endpoint that returns json with a custom HTTP code. This response is not
// caught by any other handlers.
// The `Raw` type can be used inside of a JSON type to represent a shapeless object.
#[get("/get-data")]
fn get_data() -> (u16, JSON<Raw>) {
  (203, JSON(json!({"name": "Tela"}))
}

use tela::{prelude::*, response::{JSON, Raw}, request::{Body, Query}};
use serde::{Serialize, Deserialize};

#[derive(Default, Serialize, Deserialize)]
struct User {
  name: String,
}

// The query and body can automatically be extracted from the request in the parameters.
// Just use `Body` and `Query`. If a extraction or a uri capture could be missing or you don't want
// Tela throwing a 500 error automatically, you can wrap the parameters type in an `Option`.
// Also note that the order of the parameters are not important.
#[get("/api/user/:username")]
fn get_user(query: Option<Query<User>>, username: String, Body(body): Body<i32>) -> Result<JSON<Raw>> {
  let username = match query {
    Some(User{name}) => name,
    None => String::new()
  };

  JSON(json!({"name": username, "age": body}))
}

Run an app like so.

use tela::{prelude::*, Server};

#[tela::main]
asyn fn main() {
  Server::new()
      .routes(group![home, data])
      .catch(not_found)
      .serve(3000)
      .await
}

TODO:

  • Built it timeout, throtteling, etc... with Tower
  • HTTP/1 and HTTP/2 Support (Currently only HTTP/1)

Inspiration

Tools