trait 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.
- Grouped
- Alphabetic
- By Inheritance
- FramedEntityStreamingDirectives
- MarshallingDirectives
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- type RequestToSourceUnmarshaller[T] = Unmarshaller[HttpRequest, Source[T, NotUsed]]
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from FramedEntityStreamingDirectives toany2stringadd[FramedEntityStreamingDirectives] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (FramedEntityStreamingDirectives, B)
- Implicit
- This member is added by an implicit conversion from FramedEntityStreamingDirectives toArrowAssoc[FramedEntityStreamingDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def asSourceOf[T](support: EntityStreamingSupport)(implicit um: FromByteStringUnmarshaller[T]): RequestToSourceUnmarshaller[T]
Extracts entity as pekko.stream.scaladsl.Source of elements of type
T.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 toT) 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
framingorunmarshaller.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. - final def asSourceOf[T](implicit um: FromByteStringUnmarshaller[T], support: EntityStreamingSupport): RequestToSourceUnmarshaller[T]
Extracts entity as pekko.stream.scaladsl.Source of elements of type
T.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 toT) 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
framingorunmarshaller.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. - def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- def ensuring(cond: (FramedEntityStreamingDirectives) => Boolean, msg: => Any): FramedEntityStreamingDirectives
- Implicit
- This member is added by an implicit conversion from FramedEntityStreamingDirectives toEnsuring[FramedEntityStreamingDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (FramedEntityStreamingDirectives) => Boolean): FramedEntityStreamingDirectives
- Implicit
- This member is added by an implicit conversion from FramedEntityStreamingDirectives toEnsuring[FramedEntityStreamingDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): FramedEntityStreamingDirectives
- Implicit
- This member is added by an implicit conversion from FramedEntityStreamingDirectives toEnsuring[FramedEntityStreamingDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): FramedEntityStreamingDirectives
- Implicit
- This member is added by an implicit conversion from FramedEntityStreamingDirectives toEnsuring[FramedEntityStreamingDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from FramedEntityStreamingDirectives toStringFormat[FramedEntityStreamingDirectives] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (FramedEntityStreamingDirectives, B)
- Implicit
- This member is added by an implicit conversion from FramedEntityStreamingDirectives toArrowAssoc[FramedEntityStreamingDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.