Apache Pekko HTTP
1.1.0
API
Generated with
Apache Pekko HTTP/org.apache.pekko.http/org.apache.pekko.http.scaladsl/org.apache.pekko.http.scaladsl.server/org.apache.pekko.http.scaladsl.server.directives/BasicDirectives

BasicDirectives

org.apache.pekko.http.scaladsl.server.directives.BasicDirectives
See theBasicDirectives companion object
trait BasicDirectives

Attributes

Companion
object
Source
BasicDirectives.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Directives
object Directives
class HttpApp

Members list

Grouped members

Basic directives

def cancelRejection(rejection: Rejection): Directive0

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.

Attributes

Source
BasicDirectives.scala
def cancelRejections(classes: Class[_]*): Directive0

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.

Attributes

Source
BasicDirectives.scala
def cancelRejections(cancelFilter: Rejection => Boolean): Directive0

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.

Attributes

Source
BasicDirectives.scala
def extract[T](f: RequestContext => T): Directive1[T]

Extracts a single value using the given function.

Extracts a single value using the given function.

Attributes

Source
BasicDirectives.scala
def extractActorSystem: Directive1[ActorSystem]

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.

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.

Attributes

Source
BasicDirectives.scala
def extractMatchedPath: Directive1[Path]

Extracts the already matched path from the RequestContext.

Extracts the already matched path from the RequestContext.

Attributes

Source
BasicDirectives.scala
def extractRequest: Directive1[HttpRequest]

Extracts the current HttpRequest instance.

Extracts the current HttpRequest instance.

Attributes

Source
BasicDirectives.scala
def extractSettings: Directive1[RoutingSettings]

Extracts the RoutingSettings from the pekko.http.scaladsl.server.RequestContext.

Extracts the RoutingSettings from the pekko.http.scaladsl.server.RequestContext.

Attributes

Source
BasicDirectives.scala
def extractStrictEntity(timeout: FiniteDuration): Directive1[Strict]

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.scaladsl.server.RequestContext into an pekko.http.scaladsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

Value parameters

timeout

The directive is failed if the stream isn't completed after the given timeout.

Attributes

Source
BasicDirectives.scala
def extractStrictEntity(timeout: FiniteDuration, maxBytes: Long): Directive1[Strict]

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.scaladsl.server.RequestContext into an pekko.http.scaladsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

Value parameters

timeout

The directive is failed if the stream isn't completed after the given timeout.

Attributes

Source
BasicDirectives.scala
def extractUnmatchedPath: Directive1[Path]

Extracts the yet unmatched path from the RequestContext.

Extracts the yet unmatched path from the RequestContext.

Attributes

Source
BasicDirectives.scala
def extractUri: Directive1[Uri]

Extracts the complete request URI.

Extracts the complete request URI.

Attributes

Source
BasicDirectives.scala
def mapInnerRoute(f: Route => Route): Directive0

Attributes

Source
BasicDirectives.scala
def mapSettings(f: RoutingSettings => RoutingSettings): Directive0

Runs the inner route with settings mapped by the given function.

Runs the inner route with settings mapped by the given function.

Attributes

Source
BasicDirectives.scala
def mapUnmatchedPath(f: Path => Path): Directive0

Transforms the unmatchedPath of the RequestContext using the given function.

Transforms the unmatchedPath of the RequestContext using the given function.

Attributes

Source
BasicDirectives.scala
def pass: Directive0

A Directive0 that always passes the request on to its inner route (i.e. does nothing with the request or the response).

A Directive0 that always passes the request on to its inner route (i.e. does nothing with the request or the response).

Attributes

Source
BasicDirectives.scala
def provide[T](value: T): Directive1[T]

Injects the given value into a directive.

Injects the given value into a directive.

Attributes

Source
BasicDirectives.scala
def textract[L : Tuple](f: RequestContext => L): Directive[L]

Extracts a number of values using the given function.

Extracts a number of values using the given function.

Attributes

Source
BasicDirectives.scala
def toStrictEntity(timeout: FiniteDuration): Directive0

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.scaladsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

Value parameters

timeout

The directive is failed if the stream isn't completed after the given timeout.

Attributes

Source
BasicDirectives.scala
def toStrictEntity(timeout: FiniteDuration, maxBytes: Long): Directive0

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.scaladsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

Value parameters

timeout

The directive is failed if the stream isn't completed after the given timeout.

Attributes

Source
BasicDirectives.scala
def tprovide[L : Tuple](values: L): Directive[L]

Injects the given values into a directive.

Injects the given values into a directive.

Attributes

Source
BasicDirectives.scala
def withExecutionContext(ec: ExecutionContextExecutor): Directive0

Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.

Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.

Attributes

Source
BasicDirectives.scala
def withLog(log: LoggingAdapter): Directive0

Runs its inner route with the given alternative pekko.event.LoggingAdapter.

Runs its inner route with the given alternative pekko.event.LoggingAdapter.

Attributes

Source
BasicDirectives.scala
def withMaterializer(materializer: Materializer): Directive0

Runs its inner route with the given alternative pekko.stream.Materializer.

Runs its inner route with the given alternative pekko.stream.Materializer.

Attributes

Source
BasicDirectives.scala
def withSettings(settings: RoutingSettings): Directive0

Runs its inner route with the given alternative RoutingSettings.

Runs its inner route with the given alternative RoutingSettings.

Attributes

Source
BasicDirectives.scala
Generated with