aboutsummaryrefslogtreecommitdiff
path: root/docs/backends/summary.rst
diff options
context:
space:
mode:
authoradamw <adam@warski.org>2017-10-12 18:21:00 +0200
committeradamw <adam@warski.org>2017-10-12 18:21:00 +0200
commit7885188a982c193e26f8ca6bc9aea8f6a642b32d (patch)
tree3dc9af024fabf67716902709e98743111d004a97 /docs/backends/summary.rst
parent17967df3414c19bfc7bd726ba9b26312a3c76437 (diff)
downloadsttp-7885188a982c193e26f8ca6bc9aea8f6a642b32d.tar.gz
sttp-7885188a982c193e26f8ca6bc9aea8f6a642b32d.tar.bz2
sttp-7885188a982c193e26f8ca6bc9aea8f6a642b32d.zip
Docs: initial
Diffstat (limited to 'docs/backends/summary.rst')
-rw-r--r--docs/backends/summary.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/backends/summary.rst b/docs/backends/summary.rst
new file mode 100644
index 0000000..6aa0446
--- /dev/null
+++ b/docs/backends/summary.rst
@@ -0,0 +1,18 @@
+Supported backends
+==================
+
+================================ ============================ ================================================
+Class Result wrapper Supported stream type
+================================ ============================ ================================================
+``HttpURLConnectionBackend`` None (``Id``) n/a
+``AkkaHttpBackend`` ``scala.concurrent.Future`` ``akka.stream.scaladsl.Source[ByteString, Any]``
+``AsyncHttpClientFutureBackend`` ``scala.concurrent.Future`` n/a
+``AsyncHttpClientScalazBackend`` ``scalaz.concurrent.Task`` n/a
+``AsyncHttpClientMonixBackend`` ``monix.eval.Task`` ``monix.reactive.Observable[ByteBuffer]``
+``AsyncHttpClientCatsBackend`` ``F[_]: cats.effect.Async`` n/a
+``AsyncHttpClientFs2Backend`` ``F[_]: cats.effect.Async`` ``fs2.Stream[F, ByteBuffer]``
+``OkHttpSyncBackend`` None (``Id``) n/a
+``OkHttpFutureBackend`` ``scala.concurrent.Future`` n/a
+``OkHttpMonixBackend`` ``monix.eval.Task`` ``monix.reactive.Observable[ByteBuffer]``
+================================ ============================ ================================================
+