/http-service

Types and traits for http-based services using the latest futures API

Primary LanguageRustMIT LicenseMIT

http-service

Types and traits to help you implement your own HTTP server

Crates.io version Build Status Download docs.rs docs
Built with ⛵ by The Rust Async Ecosystem WG

About

The crate http-service provides the necessary types and traits to implement your own HTTP Server. It uses hyper for the lower level TCP abstraction.

You can use the workspace member http-service-hyper to run your HTTP Server.

  1. Runs via http_service_hyper::run(HTTP_SERVICE, ADDRESS);
  2. Returns a future which can be awaited via http_service_hyper::serve(HTTP_SERVICE, ADDRESS);

This crate uses the latest Futures preview, and therefore needs to be run on Rust Nightly.

Examples

Cargo.toml

[dependencies]
http-service = "0.3.1"
http-service-hyper = "0.3.1"
futures-preview = "0.3.0-alpha.16"

main.rs

use futures::future::{self, BoxFuture, FutureExt};
use http_service::{HttpService, Response};
use std::net::{IpAddr, Ipv4Addr, SocketAddr};

struct Server {
    message: Vec<u8>,
}

impl Server {
    fn create(message: Vec<u8>) -> Server {
        Server { message }
    }

    pub fn run(s: Server) {
        let a = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8088);
        http_service_hyper::run(s, a);
    }
}

impl HttpService for Server {
    type Connection = ();
    type ConnectionFuture = future::Ready<Result<(), std::io::Error>>;
    type ResponseFuture = BoxFuture<'static, Result<http_service::Response, std::io::Error>>;

    fn connect(&self) -> Self::ConnectionFuture {
        future::ok(())
    }

    fn respond(&self, _conn: &mut (), _req: http_service::Request) -> Self::ResponseFuture {
        let message = self.message.clone();
        async move { Ok(Response::new(http_service::Body::from(message))) }.boxed()
    }
}

fn main() {
    let s = Server::create(String::from("Hello, World").into_bytes());
    Server::run(s);
}

Contributing

Want to join us? Check out our The "Contributing" section of the guide and take a look at some of these issues:

Conduct

The http-service project adheres to the Contributor Covenant Code of Conduct. This describes the minimum behavior expected from all contributors.

License

MIT OR Apache-2.0