Packages

t

akka.http.scaladsl.server

RequestContext

trait RequestContext extends AnyRef

This class is not meant to be extended by user code.

Immutable object encapsulating the context of an akka.http.scaladsl.model.HttpRequest as it flows through a akka-http Route structure.

Annotations
@DoNotInherit()
Source
RequestContext.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestContext
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def complete(obj: ToResponseMarshallable): Future[RouteResult]

    Completes the request with the given ToResponseMarshallable.

  2. implicit abstract def executionContext: ExecutionContextExecutor

    The default ExecutionContext to be used for scheduling asynchronous logic related to this request.

  3. abstract def fail(error: Throwable): Future[RouteResult]

    Bubbles the given error up the response chain where it is dealt with by the closest handleExceptions directive and its ExceptionHandler, unless the error is a RejectionError.

    Bubbles the given error up the response chain where it is dealt with by the closest handleExceptions directive and its ExceptionHandler, unless the error is a RejectionError. In this case the wrapped rejection is unpacked and "executed".

  4. abstract def log: LoggingAdapter

    The default LoggingAdapter to be used for logging messages related to this request.

  5. abstract def mapRequest(f: (HttpRequest) => HttpRequest): RequestContext

    Returns a copy of this context with the HttpRequest transformed by the given function.

  6. abstract def mapUnmatchedPath(f: (Path) => Path): RequestContext

    Returns a copy of this context with the unmatchedPath transformed by the given function.

  7. implicit abstract def materializer: Materializer

    The default Materializer.

  8. abstract def parserSettings: ParserSettings

    The default ParserSettings to be used for configuring directives.

  9. abstract def reconfigure(executionContext: ExecutionContextExecutor = executionContext, materializer: Materializer = materializer, log: LoggingAdapter = log, settings: RoutingSettings = settings): RequestContext

    Returns a copy of this context with the given fields updated.

  10. abstract def redirect(uri: Uri, redirectionType: Redirection): Future[RouteResult]

    Completes the request with redirection response of the given type to the given URI.

  11. abstract def reject(rejections: Rejection*): Future[RouteResult]

    Rejects the request with the given rejections.

  12. abstract val request: HttpRequest

    The request this context represents.

    The request this context represents. Modelled as a val so as to enable an import ctx.request._.

  13. abstract def settings: RoutingSettings

    The default RoutingSettings to be used for configuring directives.

  14. abstract val unmatchedPath: Path

    The unmatched path of this context.

    The unmatched path of this context. Modelled as a val so as to enable an import ctx.unmatchedPath._.

  15. abstract def withAcceptAll: RequestContext

    Removes a potentially existing Accept header from the request headers.

  16. abstract def withExecutionContext(ec: ExecutionContextExecutor): RequestContext

    Returns a copy of this context with the new HttpRequest.

  17. abstract def withLog(log: LoggingAdapter): RequestContext

    Returns a copy of this context with the new LoggingAdapter.

  18. abstract def withMaterializer(materializer: Materializer): RequestContext

    Returns a copy of this context with the new HttpRequest.

  19. abstract def withParserSettings(settings: ParserSettings): RequestContext

    Returns a copy of this context with the new akka.http.scaladsl.settings.ParserSettings.

  20. abstract def withRequest(req: HttpRequest): RequestContext

    Returns a copy of this context with the new HttpRequest.

  21. abstract def withRoutingSettings(settings: RoutingSettings): RequestContext

    Returns a copy of this context with the new RoutingSettings.

  22. abstract def withUnmatchedPath(path: Path): RequestContext

    Returns a copy of this context with the unmatched path updated to the given one.

Concrete 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 RequestContext toany2stringadd[RequestContext] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RequestContext, B)
    Implicit
    This member is added by an implicit conversion from RequestContext toArrowAssoc[RequestContext] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (RequestContext) => Boolean, msg: => Any): RequestContext
    Implicit
    This member is added by an implicit conversion from RequestContext toEnsuring[RequestContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (RequestContext) => Boolean): RequestContext
    Implicit
    This member is added by an implicit conversion from RequestContext toEnsuring[RequestContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): RequestContext
    Implicit
    This member is added by an implicit conversion from RequestContext toEnsuring[RequestContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): RequestContext
    Implicit
    This member is added by an implicit conversion from RequestContext toEnsuring[RequestContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RequestContext toStringFormat[RequestContext] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (RequestContext, B)
    Implicit
    This member is added by an implicit conversion from RequestContext toArrowAssoc[RequestContext] 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRequestContext to any2stringadd[RequestContext]

Inherited by implicit conversion StringFormat fromRequestContext to StringFormat[RequestContext]

Inherited by implicit conversion Ensuring fromRequestContext to Ensuring[RequestContext]

Inherited by implicit conversion ArrowAssoc fromRequestContext to ArrowAssoc[RequestContext]

Ungrouped