org.apache.pekko.http.scaladsl.server.directives

Interface FramedEntityStreamingDirectives

All Superinterfaces:

MarshallingDirectives

All Known Subinterfaces:

Directives

All Known Implementing Classes:

Directives$, HttpApp

public interface FramedEntityStreamingDirectives
extends MarshallingDirectives

Allows the MarshallingDirectives.entity directive to extract a pekko.stream.scaladsl.Source of elements.

See common.EntityStreamingSupport for useful default framing Flow instances and support traits such as SprayJsonSupport (or your other favourite JSON library) to provide the needed Marshaller s.

Method Summary

Modifier and Type	Method and Description
<T> Unmarshaller<HttpRequest,org.apache.pekko.stream.scaladsl.Source<T,org.apache.pekko.NotUsed>>	asSourceOf(EntityStreamingSupport support, Unmarshaller<org.apache.pekko.util.ByteString,T> um) Extracts entity as pekko.stream.scaladsl.Source of elements of type T.
<T> Unmarshaller<HttpRequest,org.apache.pekko.stream.scaladsl.Source<T,org.apache.pekko.NotUsed>>	asSourceOf(Unmarshaller<org.apache.pekko.util.ByteString,T> um, EntityStreamingSupport support) Extracts entity as pekko.stream.scaladsl.Source of elements of type T.
<T> Unmarshaller<HttpRequest,org.apache.pekko.stream.scaladsl.Source<T,org.apache.pekko.NotUsed>>	asSourceOfInternal(Unmarshaller<org.apache.pekko.util.ByteString,T> um, EntityStreamingSupport support)

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.MarshallingDirectives

as, completeWith, entity, handleWith, instanceOf

Method Detail

asSourceOf

<T> Unmarshaller<HttpRequest,org.apache.pekko.stream.scaladsl.Source<T,org.apache.pekko.NotUsed>> asSourceOf(Unmarshaller<org.apache.pekko.util.ByteString,T> um,
                                                                                                             EntityStreamingSupport support)

Extracts entity as pekko.stream.scaladsl.Source of elements of type T. This is achieved by applying the implicitly provided (in the following order):

- 1st: chunk-up the incoming ByteStrings by applying the Content-Type-aware framing - 2nd: apply the Unmarshaller (from ByteString to T) for each of the respective "chunks" (e.g. for each JSON element contained within an array).

The request will be rejected with an pekko.http.scaladsl.server.UnsupportedRequestContentTypeRejection if its ContentType is not supported by the used framing or unmarshaller.

Cancelling extracted pekko.stream.scaladsl.Source closes the connection abruptly (same as cancelling the entity.dataBytes).

See also MiscDirectives.withoutSizeLimit as you may want to allow streaming infinite streams of data in this route. By default the uploaded data is limited by the pekko.http.parsing.max-content-length.

Parameters:

um - (undocumented)

support - (undocumented)

Returns:

(undocumented)

asSourceOf

<T> Unmarshaller<HttpRequest,org.apache.pekko.stream.scaladsl.Source<T,org.apache.pekko.NotUsed>> asSourceOf(EntityStreamingSupport support,
                                                                                                             Unmarshaller<org.apache.pekko.util.ByteString,T> um)

Extracts entity as pekko.stream.scaladsl.Source of elements of type T. This is achieved by applying the implicitly provided (in the following order):

- 1st: chunk-up the incoming ByteStrings by applying the Content-Type-aware framing - 2nd: apply the Unmarshaller (from ByteString to T) for each of the respective "chunks" (e.g. for each JSON element contained within an array).

The request will be rejected with an pekko.http.scaladsl.server.UnsupportedRequestContentTypeRejection if its ContentType is not supported by the used framing or unmarshaller.

Cancelling extracted pekko.stream.scaladsl.Source closes the connection abruptly (same as cancelling the entity.dataBytes).

See also MiscDirectives.withoutSizeLimit as you may want to allow streaming infinite streams of data in this route. By default the uploaded data is limited by the pekko.http.parsing.max-content-length.

Parameters:

support - (undocumented)

um - (undocumented)

Returns:

(undocumented)

asSourceOfInternal

<T> Unmarshaller<HttpRequest,org.apache.pekko.stream.scaladsl.Source<T,org.apache.pekko.NotUsed>> asSourceOfInternal(Unmarshaller<org.apache.pekko.util.ByteString,T> um,
                                                                                                                     EntityStreamingSupport support)