Hyperlocal

<div align="center"> 🔌 ✨ </div> <h1 align="center"> hyperlocal </h1> <p align="center"> <a href="https://github.com/hyperium/hyper">Hyper</a> client and server bindings for <a href="https://github.com/tokio-rs/tokio/tree/master/tokio-net/src/uds/">Unix domain sockets</a> </p> <div align="center"> <a alt="GitHub Actions" href="https://github.com/softprops/hyperlocal/actions"> <img src="https://github.com/softprops/hyperlocal/workflows/Main/badge.svg"/> </a> <a alt="crates.io" href="https://crates.io/crates/hyperlocal"> <img src="https://img.shields.io/crates/v/hyperlocal.svg?logo=rust"/> </a> <a alt="docs.rs" href="http://docs.rs/hyperlocal"> <img src="https://docs.rs/hyperlocal/badge.svg"/> </a> <a alt="latest docs" href="https://softprops.github.io/hyperlocal"> <img src="https://img.shields.io/badge/docs-latest-green.svg"/> </a> <a alt="license" href="LICENSE"> <img src="https://img.shields.io/badge/license-MIT-brightgreen.svg"/> </a> </div> <br />

Hyper is a rock solid Rust HTTP client and server toolkit. Unix domain sockets provide a mechanism for host-local interprocess communication. hyperlocal builds on and complements Hyper's interfaces for building Unix domain socket HTTP clients and servers.

This is useful for exposing simple HTTP interfaces for your Unix daemons in cases where you want to limit access to the current host, in which case, opening and exposing tcp ports is not needed. Examples of Unix daemons that provide this kind of host local interface include Docker, a process container manager.

Installation

Add the following to your Cargo.toml file

[dependencies]
hyperlocal = "0.9"

Usage

Servers

A typical server can be built by creating a tokio::net::UnixListener and accepting connections in a loop using hyper::service::service_fn to create a request/response processing function, and connecting the UnixStream to it using hyper::server::conn::http1::Builder::new().serve_connection().

hyperlocal provides an extension trait UnixListenerExt with an implementation of this.

An example is at examples/server.rs, runnable via cargo run --example server

To test that your server is working you can use an out-of-the-box tool like curl

$ curl --unix-socket /tmp/hyperlocal.sock localhost

It's a Unix system. I know this.

Clients

hyperlocal also provides bindings for writing unix domain socket based HTTP clients the Client interface from the hyper-utils crate.

An example is at examples/client.rs, runnable via cargo run --example client

Hyper's client interface makes it easy to send typical HTTP methods like GET, POST, DELETE with factory methods, get, post, delete, etc. These require an argument that can be transformed into a hyper::Uri.

Since Unix domain sockets aren't represented with hostnames that resolve to ip addresses coupled with network ports, your standard over the counter URL string won't do. Instead, use a hyperlocal::Uri, which represents both file path to the domain socket and the resource URI path and query string.

---

Doug Tangren (softprops) 2015-2024