Crate feather

Feather

Feather is a lightweight, flexible, and highly extensible web framework for Rust, inspired by the simplicity and modularity of Express.js.
Feather aim’s to be simple and minimal alternative to other web frameworks such as Actix or Axum.

---

Features

• Middleware Support: Chain and compose middleware functions effortlessly.
• Route Handling: Support for multiple HTTP methods (GET, POST, PUT, DELETE, etc.).
• Lightweight: Built using Rust’s high-performance and memory-safe features.
• Thread-Safe: Leverages Rust’s thread safe aspects.

Modules

• middleware: Contains the middleware trait and related functionality
• response: Defines the Response type used throughout the framework
• sync: Contains the main application and configuration structs

Installation

To get started with Feather, add it as a dependency in your Cargo.toml:

[dependencies]
feather = "0.2.0"

Quick Start

Here’s an example of building a simple web server with Feather:

// Import dependencies from Feather
use feather::{App,MiddlewareResult};
use feather::middleware::Logger;
use feather::{Request, Response};

// Main function - no async here!
fn main() {
    // Create a new instance of App
    let mut app = App::new();
    
    // Define a route for the root path
    app.get("/", |_request: &mut Request, response: &mut Response| {
        response.send_text("Hello, world!");
        MiddlewareResult::Next
    });
    // Use the Logger middleware for all routes
    app.use_middleware(Logger);
    // Listen on port 3000
    app.listen("127.0.0.1:3000");
}

---

Middleware

Feather supports middleware for pre-processing requests and post-processing responses, and you can make your own too! Here’s an example:

// Import dependencies from Feather
use feather::{App, Request, Response};
// Import the Middleware trait and some common middleware primitives
use feather::middleware::{Logger, Middleware, MiddlewareResult};

// Implementors of the Middleware trait are middleware that can be used in a Feather app.
#[derive(Clone)]
struct Custom;

// The Middleware trait defines a single method `handle`,
// which can mutate the request and response objects, then return a `MiddlewareResult`.
impl Middleware for Custom {
    fn handle(&self, request: &mut Request, _response: &mut Response) -> MiddlewareResult {
        // Do stuff here
        println!("Now running some custom middleware (struct Custom)!");
        println!("And there's a request with path: {:?}", request.uri);
        // and then continue to the next middleware in the chain
        MiddlewareResult::Next
    }
}

fn main() {
    // Define an app
    let mut app = App::new();

    // Use the builtin Logger middleware for all routes
    app.use_middleware(Logger);

    // Use the Custom middleware for all routes
    app.use_middleware(Custom);

    // Use another middleware defined by a function for all routes
    app.use_middleware(|_request: &mut Request, _response: &mut Response| {
        println!("Now running some custom middleware (closure)!");
        MiddlewareResult::Next
    });

    // Define a route
    app.get("/", |_request: &mut Request, response: &mut Response| {
        response.send_text("Hello, world!");
        MiddlewareResult::Next
    });

    // Listen on port 3000
    app.listen("127.0.0.1:3000");
}

Built-in middleware includes:

• Logger: Logs incoming requests.
• Cors: Add cross-origin resource sharing headers to your response.
• ServeStatic: Serves Static Files in the given Directory

---

Goals

• Be the most simple & beginner-friendly web framework for Rust
• Be modular and expandable by design
• Be easy to use and learn

Contributing

Contributions are welcome! If you have ideas for improving Feather or find a bug, feel free to open an issue or submit a pull request.

1. Fork the repository.
2. Create your feature branch: git checkout -b feature/my-feature.
3. Commit your changes: git commit -m 'Add my feature'.
4. Push to the branch: git push origin feature/my-feature.
5. Open a pull request.

---

License

Feather is open-source software, licensed under the MIT License.

---

Acknowledgments

Feather is inspired by the simplicity of Express.js and aims to bring similar productivity to the Rust ecosystem. Special thanks to the Rust community for their contributions to building robust tools and libraries.

---

Known Issues

• The Logger Middleware decreases performance

Re-exports

pub use crate::middleware::Middleware;

pub use crate::middleware::MiddlewareResult;

Modules

middleware

The Middleware trait and some common middleware primitives.

Structs

App

A Feather application.

Request

Response