abstract class CodingDirectives extends CacheConditionDirectives
- Alphabetic
- By Inheritance
- CodingDirectives
- CacheConditionDirectives
- BasicDirectives
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new CodingDirectives()
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 CodingDirectives to any2stringadd[CodingDirectives] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (CodingDirectives, B)
- Implicit
- This member is added by an implicit conversion from CodingDirectives to ArrowAssoc[CodingDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
cancelRejection(rejection: Rejection, inner: Supplier[Route]): Route
Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.
Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.
- Definition Classes
- BasicDirectives
-
def
cancelRejections(filter: Predicate[Rejection], inner: Supplier[Route]): Route
Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.
Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.
- Definition Classes
- BasicDirectives
-
def
cancelRejections(classes: Iterable[Class[_]], inner: Supplier[Route]): Route
Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.
Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.
- Definition Classes
- BasicDirectives
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
conditional(eTag: Optional[EntityTag], lastModified: Optional[DateTime], inner: Supplier[Route]): Route
Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.
Note: if you want to combine this directive with
withRangeSupport(...)
you need to put it on the *outside* of thewithRangeSupport(...)
directive, i.e.withRangeSupport(...)
must be on a deeper level in your route structure in order to function correctly.- Definition Classes
- CacheConditionDirectives
-
def
conditional(eTag: EntityTag, lastModified: DateTime, inner: Supplier[Route]): Route
Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.
Note: if you want to combine this directive with
withRangeSupport(...)
you need to put it on the *outside* of thewithRangeSupport(...)
directive, i.e.withRangeSupport(...)
must be on a deeper level in your route structure in order to function correctly.- Definition Classes
- CacheConditionDirectives
-
def
conditional(lastModified: DateTime, inner: Supplier[Route]): Route
Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.
Note: if you want to combine this directive with
withRangeSupport(...)
you need to put it on the *outside* of thewithRangeSupport(...)
directive, i.e.withRangeSupport(...)
must be on a deeper level in your route structure in order to function correctly.- Definition Classes
- CacheConditionDirectives
-
def
conditional(eTag: EntityTag, inner: Supplier[Route]): Route
Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.
Note: if you want to combine this directive with
withRangeSupport(...)
you need to put it on the *outside* of thewithRangeSupport(...)
directive, i.e.withRangeSupport(...)
must be on a deeper level in your route structure in order to function correctly.- Definition Classes
- CacheConditionDirectives
-
def
decodeRequest(inner: Supplier[Route]): Route
Decompresses the incoming request if it is
gzip
ordeflate
compressed.Decompresses the incoming request if it is
gzip
ordeflate
compressed. Uncompressed requests are passed through untouched. If the request encoded with another encoding the request is rejected with anUnsupportedRequestEncodingRejection
. -
def
decodeRequestWith(coders: Iterable[Coder], inner: Supplier[Route]): Route
Decodes the incoming request if it is encoded with one of the given encoders.
Decodes the incoming request if it is encoded with one of the given encoders. If the request encoding doesn't match one of the given encoders the request is rejected with an
UnsupportedRequestEncodingRejection
. If no decoders are given the default encoders (Gzip
,Deflate
,NoCoding
) are used. -
def
decodeRequestWith(coder: Coder, inner: Supplier[Route]): Route
Decodes the incoming request using the given Decoder.
Decodes the incoming request using the given Decoder. If the request encoding doesn't match the request is rejected with an
UnsupportedRequestEncodingRejection
. -
def
encodeResponse(inner: Supplier[Route]): Route
Encodes the response with the encoding that is requested by the client via the
Accept- Encoding
header.Encodes the response with the encoding that is requested by the client via the
Accept- Encoding
header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.If the
Accept-Encoding
header is missing or empty or specifies an encoding other than identity, gzip or deflate then no encoding is used. -
def
encodeResponseWith(coders: Iterable[Coder], inner: Supplier[Route]): Route
Encodes the response with the encoding that is requested by the client via the
Accept- Encoding
header.Encodes the response with the encoding that is requested by the client via the
Accept- Encoding
header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.If the
Accept-Encoding
header is missing then the response is encoded using thefirst
encoder.If the
Accept-Encoding
header is empty andNoCoding
is part of the encoders then no response encoding is used. Otherwise the request is rejected.If [encoders] is empty, no encoding is performed.
-
def
ensuring(cond: (CodingDirectives) ⇒ Boolean, msg: ⇒ Any): CodingDirectives
- Implicit
- This member is added by an implicit conversion from CodingDirectives to Ensuring[CodingDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (CodingDirectives) ⇒ Boolean): CodingDirectives
- Implicit
- This member is added by an implicit conversion from CodingDirectives to Ensuring[CodingDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): CodingDirectives
- Implicit
- This member is added by an implicit conversion from CodingDirectives to Ensuring[CodingDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): CodingDirectives
- Implicit
- This member is added by an implicit conversion from CodingDirectives to Ensuring[CodingDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
extract[T](extract: Function[RequestContext, T], inner: Function[T, Route]): Route
Extracts a single value using the given function.
Extracts a single value using the given function.
- Definition Classes
- BasicDirectives
-
def
extractActorSystem(inner: Function[ActorSystem, Route]): Route
Extracts the akka.actor.ActorSystem if the available Materializer is an akka.stream.ActorMaterializer.
Extracts the akka.actor.ActorSystem if the available Materializer is an akka.stream.ActorMaterializer. Otherwise throws an exception as it won't be able to extract the system from arbitrary materializers.
- Definition Classes
- BasicDirectives
-
def
extractDataBytes(inner: Function[Source[ByteString, Any], Route]): RouteAdapter
Extracts the entities
dataBytes
akka.stream.javadsl.Source from the akka.http.javadsl.server.RequestContext.Extracts the entities
dataBytes
akka.stream.javadsl.Source from the akka.http.javadsl.server.RequestContext.- Definition Classes
- BasicDirectives
-
def
extractEntity(inner: Function[RequestEntity, Route]): Route
Extracts the current http request entity.
Extracts the current http request entity.
- Definition Classes
- BasicDirectives
- Annotations
- @CorrespondsTo()
-
def
extractExecutionContext(inner: Function[ExecutionContextExecutor, Route]): Route
Extracts the ExecutionContextExecutor from the RequestContext.
Extracts the ExecutionContextExecutor from the RequestContext.
- Definition Classes
- BasicDirectives
-
def
extractLog(inner: Function[LoggingAdapter, Route]): Route
Extracts the LoggingAdapter
Extracts the LoggingAdapter
- Definition Classes
- BasicDirectives
-
def
extractMatchedPath(inner: Function[String, Route]): RouteAdapter
Extracts the already matched path from the RequestContext.
Extracts the already matched path from the RequestContext.
- Definition Classes
- BasicDirectives
-
def
extractMaterializer(inner: Function[Materializer, Route]): Route
Extracts the Materializer from the RequestContext.
Extracts the Materializer from the RequestContext.
- Definition Classes
- BasicDirectives
-
def
extractParserSettings(inner: Function[ParserSettings, Route]): RouteAdapter
Extracts the akka.http.javadsl.settings.ParserSettings from the akka.http.javadsl.server.RequestContext.
Extracts the akka.http.javadsl.settings.ParserSettings from the akka.http.javadsl.server.RequestContext.
- Definition Classes
- BasicDirectives
-
def
extractRequest(inner: Function[HttpRequest, Route]): RouteAdapter
Extracts the current HttpRequest instance.
Extracts the current HttpRequest instance.
- Definition Classes
- BasicDirectives
-
def
extractRequestContext(inner: Function[RequestContext, Route]): RouteAdapter
Extracts the akka.http.javadsl.server.RequestContext itself.
Extracts the akka.http.javadsl.server.RequestContext itself.
- Definition Classes
- BasicDirectives
-
def
extractRequestEntity(inner: Function[RequestEntity, Route]): Route
Extracts the akka.http.javadsl.model.RequestEntity from the akka.http.javadsl.server.RequestContext.
Extracts the akka.http.javadsl.model.RequestEntity from the akka.http.javadsl.server.RequestContext.
- Definition Classes
- BasicDirectives
-
def
extractSettings(inner: Function[RoutingSettings, Route]): RouteAdapter
Extracts the RoutingSettings from the akka.http.javadsl.server.RequestContext.
Extracts the RoutingSettings from the akka.http.javadsl.server.RequestContext.
- Definition Classes
- BasicDirectives
-
def
extractStrictEntity(timeout: FiniteDuration, maxBytes: Long, inner: Function[Strict, Route]): Route
WARNING: This will read the entire request entity into memory and effectively disable streaming.
WARNING: This will read the entire request entity into memory and effectively disable streaming.
To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the
akka.http.parsing.max-to-strict-bytes
configuration setting.Converts the HttpEntity from the akka.http.javadsl.server.RequestContext into an akka.http.javadsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.
- timeout
The directive is failed if the stream isn't completed after the given timeout.
- Definition Classes
- BasicDirectives
-
def
extractStrictEntity(timeout: FiniteDuration, inner: Function[Strict, Route]): Route
WARNING: This will read the entire request entity into memory and effectively disable streaming.
WARNING: This will read the entire request entity into memory and effectively disable streaming.
To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the
akka.http.parsing.max-to-strict-bytes
configuration setting.Converts the HttpEntity from the akka.http.javadsl.server.RequestContext into an akka.http.javadsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.
- timeout
The directive is failed if the stream isn't completed after the given timeout.
- Definition Classes
- BasicDirectives
-
def
extractUnmatchedPath(inner: Function[String, Route]): RouteAdapter
Extracts the yet unmatched path from the RequestContext.
Extracts the yet unmatched path from the RequestContext.
- Definition Classes
- BasicDirectives
-
def
extractUri(inner: Function[Uri, Route]): RouteAdapter
Extracts the complete request URI.
Extracts the complete request URI.
- Definition Classes
- BasicDirectives
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CodingDirectives to StringFormat[CodingDirectives] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
mapInnerRoute(f: Function[Route, Route], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapRejections(f: Function[List[Rejection], List[Rejection]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapRequest(f: Function[HttpRequest, HttpRequest], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapRequestContext(f: Function[RequestContext, RequestContext], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapResponse(f: Function[HttpResponse, HttpResponse], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapResponseEntity(f: Function[ResponseEntity, ResponseEntity], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapResponseHeaders(f: Function[List[HttpHeader], List[HttpHeader]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapRouteResult(f: Function[RouteResult, RouteResult], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapRouteResultFuture(f: Function[CompletionStage[RouteResult], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapRouteResultWith(f: Function[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapRouteResultWithPF(f: PartialFunction[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
mapSettings(f: Function[RoutingSettings, RoutingSettings], inner: Supplier[Route]): Route
Runs the inner route with settings mapped by the given function.
Runs the inner route with settings mapped by the given function.
- Definition Classes
- BasicDirectives
-
def
mapUnmatchedPath(f: Function[String, String], inner: Supplier[Route]): Route
Transforms the unmatchedPath of the RequestContext using the given function.
Transforms the unmatchedPath of the RequestContext using the given function.
- Definition Classes
- BasicDirectives
-
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()
-
def
pass(inner: Supplier[Route]): Route
Always passes the request on to its inner route (i.e.
Always passes the request on to its inner route (i.e. does nothing with the request or the response).
- Definition Classes
- BasicDirectives
-
def
provide[T](t: T, inner: Function[T, Route]): Route
Injects the given value into a directive.
Injects the given value into a directive.
- Definition Classes
- BasicDirectives
-
def
recoverRejections(f: Function[Iterable[Rejection], RouteResult], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
recoverRejectionsWith(f: Function[Iterable[Rejection], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- Definition Classes
- BasicDirectives
-
def
requestEncodedWith(encoding: HttpEncoding, inner: Supplier[Route]): Route
Rejects the request with an UnsupportedRequestEncodingRejection if its encoding doesn't match the given one.
-
def
responseEncodingAccepted(encoding: HttpEncoding, inner: Supplier[Route]): Route
Rejects the request with an UnacceptedResponseEncodingRejection if the given response encoding is not accepted by the client.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toStrictEntity(timeout: FiniteDuration, maxBytes: Long, inner: Supplier[Route]): Route
WARNING: This will read the entire request entity into memory and effectively disable streaming.
WARNING: This will read the entire request entity into memory and effectively disable streaming.
To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the
akka.http.parsing.max-to-strict-bytes
configuration setting.Extracts the akka.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.
- timeout
The directive is failed if the stream isn't completed after the given timeout.
- Definition Classes
- BasicDirectives
-
def
toStrictEntity(timeout: FiniteDuration, inner: Supplier[Route]): Route
WARNING: This will read the entire request entity into memory and effectively disable streaming.
WARNING: This will read the entire request entity into memory and effectively disable streaming.
To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the
akka.http.parsing.max-to-strict-bytes
configuration setting.Extracts the akka.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.
- timeout
The directive is failed if the stream isn't completed after the given timeout.
- Definition Classes
- BasicDirectives
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
withExecutionContext(ec: ExecutionContextExecutor, inner: Supplier[Route]): Route
Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.
Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.
- Definition Classes
- BasicDirectives
-
def
withLog(log: LoggingAdapter, inner: Supplier[Route]): Route
Runs its inner route with the given alternative LoggingAdapter.
Runs its inner route with the given alternative LoggingAdapter.
- Definition Classes
- BasicDirectives
-
def
withMaterializer(mat: Materializer, inner: Supplier[Route]): Route
Runs its inner route with the given alternative akka.stream.Materializer.
Runs its inner route with the given alternative akka.stream.Materializer.
- Definition Classes
- BasicDirectives
-
def
withPrecompressedMediaTypeSupport(inner: Supplier[Route]): Route
Inspects the response entity and adds a
Content-Encoding: gzip
response header if the entity's media-type is precompressed with gzip and noContent-Encoding
header is present yet. -
def
withSettings(s: RoutingSettings, inner: Supplier[Route]): Route
Runs its inner route with the given alternative RoutingSettings.
Runs its inner route with the given alternative RoutingSettings.
- Definition Classes
- BasicDirectives
-
def
→[B](y: B): (CodingDirectives, B)
- Implicit
- This member is added by an implicit conversion from CodingDirectives to ArrowAssoc[CodingDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc