t

akka.http.scaladsl.server.directives

FramedEntityStreamingDirectives

trait FramedEntityStreamingDirectives extends MarshallingDirectives

Allows the MarshallingDirectives.entity directive to extract a akka.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.

Source
FramedEntityStreamingDirectives.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. FramedEntityStreamingDirectives
  2. MarshallingDirectives
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type RequestToSourceUnmarshaller[T] = Unmarshaller[HttpRequest, Source[T, NotUsed]]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from FramedEntityStreamingDirectives to any2stringadd[FramedEntityStreamingDirectives] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (FramedEntityStreamingDirectives, B)
    Implicit
    This member is added by an implicit conversion from FramedEntityStreamingDirectives to ArrowAssoc[FramedEntityStreamingDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def as[T](implicit um: FromRequestUnmarshaller[T]): FromRequestUnmarshaller[T]

    Returns the in-scope FromRequestUnmarshaller for the given type.

    Returns the in-scope FromRequestUnmarshaller for the given type.

    Definition Classes
    MarshallingDirectives
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. final def asSourceOf[T](support: EntityStreamingSupport)(implicit um: FromByteStringUnmarshaller[T]): RequestToSourceUnmarshaller[T]

    Extracts entity as akka.stream.scaladsl.Source of elements of type T.

    Extracts entity as akka.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 akka.http.scaladsl.server.UnsupportedRequestContentTypeRejection if its ContentType is not supported by the used framing or unmarshaller.

    Cancelling extracted akka.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 akka.http.parsing.max-content-length.

  9. final def asSourceOf[T](implicit um: FromByteStringUnmarshaller[T], support: EntityStreamingSupport): RequestToSourceUnmarshaller[T]

    Extracts entity as akka.stream.scaladsl.Source of elements of type T.

    Extracts entity as akka.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 akka.http.scaladsl.server.UnsupportedRequestContentTypeRejection if its ContentType is not supported by the used framing or unmarshaller.

    Cancelling extracted akka.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 akka.http.parsing.max-content-length.

  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def completeWith[T](marshaller: ToResponseMarshaller[T])(inner: ((T) ⇒ Unit) ⇒ Unit): Route

    Uses the marshaller for the given type to produce a completion function that is passed to its inner function.

    Uses the marshaller for the given type to produce a completion function that is passed to its inner function. You can use it do decouple marshaller resolution from request completion.

    Definition Classes
    MarshallingDirectives
  12. def ensuring(cond: (FramedEntityStreamingDirectives) ⇒ Boolean, msg: ⇒ Any): FramedEntityStreamingDirectives
    Implicit
    This member is added by an implicit conversion from FramedEntityStreamingDirectives to Ensuring[FramedEntityStreamingDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (FramedEntityStreamingDirectives) ⇒ Boolean): FramedEntityStreamingDirectives
    Implicit
    This member is added by an implicit conversion from FramedEntityStreamingDirectives to Ensuring[FramedEntityStreamingDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): FramedEntityStreamingDirectives
    Implicit
    This member is added by an implicit conversion from FramedEntityStreamingDirectives to Ensuring[FramedEntityStreamingDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): FramedEntityStreamingDirectives
    Implicit
    This member is added by an implicit conversion from FramedEntityStreamingDirectives to Ensuring[FramedEntityStreamingDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def entity[T](um: FromRequestUnmarshaller[T]): Directive1[T]

    Unmarshalls the requests entity to the given type passes it to its inner Route.

    Unmarshalls the requests entity to the given type passes it to its inner Route. If there is a problem with unmarshalling the request is rejected with the Rejection produced by the unmarshaller.

    Definition Classes
    MarshallingDirectives
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from FramedEntityStreamingDirectives to StringFormat[FramedEntityStreamingDirectives] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  22. def handleWith[A, B](f: (A) ⇒ B)(implicit um: FromRequestUnmarshaller[A], m: ToResponseMarshaller[B]): Route

    Completes the request using the given function.

    Completes the request using the given function. The input to the function is produced with the in-scope entity unmarshaller and the result value of the function is marshalled with the in-scope marshaller.

    Definition Classes
    MarshallingDirectives
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  24. def instanceOf[T](implicit m: ToResponseMarshaller[T]): ToResponseMarshaller[T]

    Returns the in-scope Marshaller for the given type.

    Returns the in-scope Marshaller for the given type.

    Definition Classes
    MarshallingDirectives
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def [B](y: B): (FramedEntityStreamingDirectives, B)
    Implicit
    This member is added by an implicit conversion from FramedEntityStreamingDirectives to ArrowAssoc[FramedEntityStreamingDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from MarshallingDirectives

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from FramedEntityStreamingDirectives to any2stringadd[FramedEntityStreamingDirectives]

Inherited by implicit conversion StringFormat from FramedEntityStreamingDirectives to StringFormat[FramedEntityStreamingDirectives]

Inherited by implicit conversion Ensuring from FramedEntityStreamingDirectives to Ensuring[FramedEntityStreamingDirectives]

Inherited by implicit conversion ArrowAssoc from FramedEntityStreamingDirectives to ArrowAssoc[FramedEntityStreamingDirectives]

Marshalling directives

Ungrouped