#unix-socket #unix #routerify #hyper #hyperlocal #http #request-object

routerify-unixsocket

Use hyperlocal with routerify to add local unix socket support

3 releases (1 stable)

3.0.0 Jan 15, 2022
0.1.1 Mar 20, 2021
0.1.0 Mar 20, 2021

#1289 in HTTP server

Download history 6/week @ 2024-08-01 1/week @ 2024-08-08 13/week @ 2024-08-15 10/week @ 2024-08-22 11/week @ 2024-08-29 5/week @ 2024-09-05 2/week @ 2024-09-12 18/week @ 2024-09-19 29/week @ 2024-09-26 20/week @ 2024-10-03 3/week @ 2024-10-10 12/week @ 2024-10-17 113/week @ 2024-10-24 5/week @ 2024-10-31

135 downloads per month
Used in minidsp-daemon

MIT/Apache

14KB
142 lines

routerify-unixsocket

Crates.io Docs.rs CI Coverage Status

Routerify <> Hyperlocal

Usage

Serve unix sockets with routerify

Basic usage works by replacing RouterService with UnixRouterService, which adapts the request in order to be compatible with routerify's RequestService.

Since routerify requires an IP SocketAddr, the loopback address 127.0.0.1 with port 0 is used as a placeholder. In order to access the unix socket's peer address and peer credential, the UnixRequestExt extension trait adds methods to the request object.

Example

use hyper::{Body, Response, Server};
use hyperlocal::UnixServerExt;
use routerify::{Error, Router};
use routerify_unixsocket::{UnixRequestExt, UnixRouterService};
use std::{fs, path::Path};

#[tokio::main]
async fn main() {
    let path = Path::new("/tmp/hyperlocal.sock");
    if path.exists() {
        fs::remove_file(path).unwrap();
    }

    let router: Router<Body, Error> = Router::builder()
        .get("/", |req| async move {
            let s = format!("You are: {:?}", req.unix_peer_cred());
            Ok(Response::new(Body::from(s)))
        })
        .build()
        .unwrap();

    let service = UnixRouterService::new(router).unwrap();
        Server::bind_unix(path)
            .unwrap()
            .serve(service)
            .await
            .unwrap()
}

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~8–18MB
~234K SLoC