Package akka.http.scaladsl.common
Class StrictForm
java.lang.Object
akka.http.scaladsl.common.StrictForm
Read-only abstraction on top of
application/x-www-form-urlencoded
and multipart form data,
allowing joint unmarshalling access to either kind, **if** you supply both, a akka.http.scaladsl.unmarshalling.FromStringUnmarshaller
as well as a akka.http.scaladsl.unmarshalling.FromEntityUnmarshaller
for the target type T
.
Note: In order to allow for random access to the field values streamed multipart form data are strictified!
Don't use this abstraction on potentially unbounded forms (e.g. large file uploads).
If you only need to consume one type of form (application/x-www-form-urlencoded
*or* multipart) then
simply unmarshal directly to the respective form abstraction (FormData
or Multipart.FormData
)
rather than going through StrictForm
.
Simple usage example:
val strictFormFuture = Unmarshal(entity).to[StrictForm]
val fooFieldUnmarshalled: Future[T] =
strictFormFuture flatMap { form =>
Unmarshal(form field "foo").to[T]
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static class
static final class
Simple model for strict file content in a multipart form data part.static class
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionscala.Option<StrictForm.Field>
abstract scala.collection.immutable.Seq<scala.Tuple2<String,
StrictForm.Field>> fields()
static scala.concurrent.duration.FiniteDuration
static Unmarshaller<HttpEntity,
StrictForm> unmarshaller
(Unmarshaller<HttpEntity, FormData> formDataUM, Unmarshaller<HttpEntity, Multipart.FormData> multipartUM)
-
Constructor Details
-
StrictForm
public StrictForm()
-
-
Method Details
-
toStrictTimeout
public static scala.concurrent.duration.FiniteDuration toStrictTimeout() -
unmarshaller
public static Unmarshaller<HttpEntity,StrictForm> unmarshaller(Unmarshaller<HttpEntity, FormData> formDataUM, Unmarshaller<HttpEntity, Multipart.FormData> multipartUM) -
fields
-
field
-