diff options
author | adamw <adam@warski.org> | 2017-08-30 13:40:30 +0200 |
---|---|---|
committer | adamw <adam@warski.org> | 2017-08-30 13:40:30 +0200 |
commit | e7297b85f79d6531cb487550994dbde277779f9b (patch) | |
tree | ace36443071ddd432de6799eaa61d743a80a3172 /core | |
parent | dc417df3abb3d775bd1cd71b23f591b9aef33533 (diff) | |
download | sttp-e7297b85f79d6531cb487550994dbde277779f9b.tar.gz sttp-e7297b85f79d6531cb487550994dbde277779f9b.tar.bz2 sttp-e7297b85f79d6531cb487550994dbde277779f9b.zip |
Move javadoc
Diffstat (limited to 'core')
-rw-r--r-- | core/src/main/scala/com/softwaremill/sttp/RequestT.scala | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/core/src/main/scala/com/softwaremill/sttp/RequestT.scala b/core/src/main/scala/com/softwaremill/sttp/RequestT.scala index 8d46901..5e4d33e 100644 --- a/core/src/main/scala/com/softwaremill/sttp/RequestT.scala +++ b/core/src/main/scala/com/softwaremill/sttp/RequestT.scala @@ -10,6 +10,12 @@ import scala.collection.immutable.Seq import scala.language.higherKinds /** + * @param response What's the target type to which the response body should + * be read. Needs to be specified upfront so that the response + * is always consumed and hence there are no requirements on + * client code to consume it. An exception to this are + * streaming responses, which need to fully consumed by the + * client if such a response type is requested. * @tparam U Specifies if the method & uri are specified. By default can be * either: * * `Empty`, which is a type constructor which always resolves to @@ -206,13 +212,6 @@ case class RequestT[U[_], T, +S]( def streamBody[S2 >: S](b: S2): RequestT[U, T, S2] = copy[U, T, S2](body = StreamBody(b)) - /** - * What's the target type to which the response body should be read. - * Needs to be specified upfront so that the response is always consumed - * and hence there are no requirements on client code to consume it. An - * exception to this are streaming responses, which need to fully - * consumed by the client if such a response type is requested. - */ def response[T2, S2 >: S](ra: ResponseAs[T2, S2]): RequestT[U, T2, S2] = this.copy(response = ra) |