abstract class BasicDirectives extends AnyRef
- Alphabetic
- By Inheritance
- BasicDirectives
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new BasicDirectives()
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 BasicDirectives toany2stringadd[BasicDirectives] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (BasicDirectives, B)
- Implicit
- This member is added by an implicit conversion from BasicDirectives toArrowAssoc[BasicDirectives] 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.
- 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.
- 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.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (BasicDirectives) => Boolean, msg: => Any): BasicDirectives
- Implicit
- This member is added by an implicit conversion from BasicDirectives toEnsuring[BasicDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (BasicDirectives) => Boolean): BasicDirectives
- Implicit
- This member is added by an implicit conversion from BasicDirectives toEnsuring[BasicDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): BasicDirectives
- Implicit
- This member is added by an implicit conversion from BasicDirectives toEnsuring[BasicDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): BasicDirectives
- Implicit
- This member is added by an implicit conversion from BasicDirectives toEnsuring[BasicDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): 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.
- def extractActorSystem(inner: Function[ActorSystem, Route]): Route
Extracts the pekko.actor.ActorSystem if the available Materializer is an pekko.stream.ActorMaterializer.
Extracts the pekko.actor.ActorSystem if the available Materializer is an pekko.stream.ActorMaterializer. Otherwise throws an exception as it won't be able to extract the system from arbitrary materializers.
- def extractDataBytes(inner: Function[Source[ByteString, Any], Route]): RouteAdapter
Extracts the entities
dataBytes
pekko.stream.javadsl.Source from the pekko.http.javadsl.server.RequestContext. - def extractEntity(inner: Function[RequestEntity, Route]): Route
Extracts the current http request entity.
Extracts the current http request entity.
- Annotations
- @CorrespondsTo()
- def extractExecutionContext(inner: Function[ExecutionContextExecutor, Route]): Route
Extracts the ExecutionContextExecutor from the RequestContext.
- def extractLog(inner: Function[LoggingAdapter, Route]): Route
Extracts the LoggingAdapter
- def extractMatchedPath(inner: Function[String, Route]): RouteAdapter
Extracts the already matched path from the RequestContext.
- def extractMaterializer(inner: Function[Materializer, Route]): Route
Extracts the Materializer from the RequestContext.
- def extractParserSettings(inner: Function[ParserSettings, Route]): RouteAdapter
Extracts the pekko.http.javadsl.settings.ParserSettings from the pekko.http.javadsl.server.RequestContext.
- def extractRequest(inner: Function[HttpRequest, Route]): RouteAdapter
Extracts the current HttpRequest instance.
- def extractRequestContext(inner: Function[RequestContext, Route]): RouteAdapter
Extracts the pekko.http.javadsl.server.RequestContext itself.
- def extractRequestEntity(inner: Function[RequestEntity, Route]): Route
Extracts the pekko.http.javadsl.model.RequestEntity from the pekko.http.javadsl.server.RequestContext.
- def extractSettings(inner: Function[RoutingSettings, Route]): RouteAdapter
Extracts the RoutingSettings from the pekko.http.javadsl.server.RequestContext.
- 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
pekko.http.parsing.max-to-strict-bytes
configuration setting.Converts the HttpEntity from the pekko.http.javadsl.server.RequestContext into an pekko.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.
- 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
pekko.http.parsing.max-to-strict-bytes
configuration setting.Converts the HttpEntity from the pekko.http.javadsl.server.RequestContext into an pekko.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.
- def extractUnmatchedPath(inner: Function[String, Route]): RouteAdapter
Extracts the yet unmatched path from the RequestContext.
- def extractUri(inner: Function[Uri, Route]): RouteAdapter
Extracts the complete request URI.
- 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 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
- def mapRejections(f: Function[List[Rejection], List[Rejection]], inner: Supplier[Route]): Route
- def mapRequest(f: Function[HttpRequest, HttpRequest], inner: Supplier[Route]): Route
- def mapRequestContext(f: Function[RequestContext, RequestContext], inner: Supplier[Route]): Route
- def mapResponse(f: Function[HttpResponse, HttpResponse], inner: Supplier[Route]): Route
- def mapResponseEntity(f: Function[ResponseEntity, ResponseEntity], inner: Supplier[Route]): Route
- def mapResponseHeaders(f: Function[List[HttpHeader], List[HttpHeader]], inner: Supplier[Route]): Route
- def mapRouteResult(f: Function[RouteResult, RouteResult], inner: Supplier[Route]): Route
- def mapRouteResultFuture(f: Function[CompletionStage[RouteResult], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- def mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult], inner: Supplier[Route]): Route
- def mapRouteResultWith(f: Function[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- def mapRouteResultWithPF(f: PartialFunction[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- def mapSettings(f: Function[RoutingSettings, RoutingSettings], inner: Supplier[Route]): Route
Runs the inner route with settings mapped by the given function.
- def mapUnmatchedPath(f: Function[String, String], inner: Supplier[Route]): Route
Transforms the unmatchedPath of the RequestContext using the given function.
- 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).
- def provide[T](t: T, inner: Function[T, Route]): Route
Injects the given value into a directive.
- def recoverRejections(f: Function[Iterable[Rejection], RouteResult], inner: Supplier[Route]): Route
- def recoverRejectionsWith(f: Function[Iterable[Rejection], CompletionStage[RouteResult]], inner: Supplier[Route]): Route
- 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
pekko.http.parsing.max-to-strict-bytes
configuration setting.Extracts the pekko.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.
- 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
pekko.http.parsing.max-to-strict-bytes
configuration setting.Extracts the pekko.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.
- 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()
- def withExecutionContext(ec: ExecutionContextExecutor, inner: Supplier[Route]): Route
Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.
- def withLog(log: LoggingAdapter, inner: Supplier[Route]): Route
Runs its inner route with the given alternative LoggingAdapter.
- def withMaterializer(mat: Materializer, inner: Supplier[Route]): Route
Runs its inner route with the given alternative pekko.stream.Materializer.
- def withSettings(s: RoutingSettings, inner: Supplier[Route]): Route
Runs its inner route with the given alternative RoutingSettings.
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from BasicDirectives toStringFormat[BasicDirectives] 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,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (BasicDirectives, B)
- Implicit
- This member is added by an implicit conversion from BasicDirectives toArrowAssoc[BasicDirectives] 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.