package shuttle_http

You can search for identifiers within the package.

in-package search v0.2.0

Async library for HTTP/1.1 servers and clients

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (10)

Authors

A

Anurag Soni

Maintainers

A

Anurag Soni <anurag@sonianurag.com>

Sources

shuttle_http-0.12.0.tbz

sha256=073651dfcbe88a29856ae9568583ecece3df659aa74470ca92671e388ccc9351

sha512=78a8f4517238a7332cf5211f250aa031a3f64fcdf3617c23f072183bbbd9535e295cdef9551d24e4451ef674e0ce6845296960f66ca9c28b81430f4cf0dda563

doc/shuttle_http/Shuttle_http/Body/index.html

Module `Shuttle_http.Body`Source

Sourcemodule Stream : sig ... end

Stream represents streaming HTTP bodies. This module provides utilities to create and consume streams, while enforcing the invariant that only one consume can read from a stream, and that a stream can only be consumed once.

Sourcetype t = private

| Empty
| Fixed of string
| Stream of Stream.t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Sourceval string : string -> t

string str creates a fixed length encoded body from a user provided string.

Sourceval empty : t

empty is a zero length body.

Sourceval of_pipe : [ `Chunked | `Fixed of int ] -> string Async.Pipe.Reader.t -> t

of_pipe is a convenience function that creates a streaming body from a user provided Async_kernel.Pipe.Reader.t. The pipe will be closed whenever the streaming body is closed, or EOF is reached.

Sourceval stream : Stream.t -> t

stream creates a streaming body from a user provided streaming module.

Sourceval to_stream : t -> Stream.t

to_stream converts a HTTP body to a stream.

Sourceval to_string : t -> string Async.Deferred.t

to_string returns a deferred that will be fulfilled with the entire body converted to a string.