https://github.com/sammhicks/picoserve

An async no_std HTTP server suitable for bare-metal environments, heavily inspired by axum
https://github.com/sammhicks/picoserve

Last synced: 13 days ago
JSON representation

An async no_std HTTP server suitable for bare-metal environments, heavily inspired by axum

• Host: GitHub
• URL: https://github.com/sammhicks/picoserve
• Owner: sammhicks
• License: mit
• Created: 2023-09-01T10:53:13.000Z (about 1 year ago)
• Default Branch: development
• Last Pushed: 2024-08-26T13:39:24.000Z (3 months ago)
• Last Synced: 2024-09-15T15:10:20.382Z (about 2 months ago)
• Language: Rust
• Homepage:
• Size: 345 KB
• Stars: 189
• Watchers: 7
• Forks: 21
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# picoserve

An async `no_std` HTTP server suitable for bare-metal environments, heavily inspired by [axum](https://github.com/tokio-rs/axum).

It was designed with [embassy](https://embassy.dev/) on the Raspberry Pi Pico W in mind, but should work with other embedded runtimes and hardware.

Features:

+ No heap usage

+ Handler functions are just async functions that accept zero or more extractors as arguments and returns something that implements IntoResponse

+ Query and Form parsing using serde

+ JSON responses

+ Server-Sent Events

+ Web Sockets

+ HEAD method is automatically handled

Shortcomings:

+ While in version `0.*.*`, there may be breaking API changes

+ Only the GET, POST, and HEAD methods are supported.

+ URL-Encoded strings, for example in Query and Form parsing, have a maximum length of 1024.

+ This has relatively little stress-testing so I advise not to expose it directly to the internet, but place it behind a proxy such as nginx, which will act as a security layer.

+ Certain serialization methods, such as the DebugValue response and JSON serialisation might be called several times if the response payload is large. The caller MUST ensure that the output of serialisation is the same during repeated calls with the same value.

+ The framework does not verify that the specified length of a reponse body, i.e. the value stored in the "Content-Length" header is actually the length of the body.

## Usage examples

### tokio (for testing purposes)

```rust

use std::time::Duration;

use picoserve::routing::get;

#[tokio::main(flavor = "current_thread")]

async fn main() -> anyhow::Result<()> {

    let port = 8000;

    let app =

        std::rc::Rc::new(picoserve::Router::new().route("/", get(|| async { "Hello World" })));

    let config = picoserve::Config::new(picoserve::Timeouts {

        start_read_request: Some(Duration::from_secs(5)),

        read_request: Some(Duration::from_secs(1)),

        write: Some(Duration::from_secs(1)),

    })

    .keep_connection_alive();

    let socket = tokio::net::TcpListener::bind((std::net::Ipv4Addr::LOCALHOST, port)).await?;

    println!("http://localhost:{port}/");

    tokio::task::LocalSet::new()

        .run_until(async {

            loop {

                let (stream, remote_address) = socket.accept().await?;

                println!("Connection from {remote_address}");

                let app = app.clone();

                let config = config.clone();

                tokio::task::spawn_local(async move {

                    match picoserve::serve(&app, &config, &mut [0; 2048], stream).await {

                        Ok(handled_requests_count) => {

                            println!(

                                "{handled_requests_count} requests handled from {remote_address}"

                            )

                        }

                        Err(err) => println!("{err:?}"),

                    }

                });

            }

        })

        .await

}

```