trait RequestContext extends AnyRef
This class is not meant to be extended by user code.
Immutable object encapsulating the context of an pekko.http.scaladsl.model.HttpRequest as it flows through a pekko-http Route structure.
- Annotations
- @DoNotInherit()
- Source
- RequestContext.scala
- Alphabetic
- By Inheritance
- RequestContext
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def complete(obj: ToResponseMarshallable): Future[RouteResult]
Completes the request with the given ToResponseMarshallable.
- implicit abstract def executionContext: ExecutionContextExecutor
The default ExecutionContext to be used for scheduling asynchronous logic related to this request.
- abstract def fail(error: Throwable): Future[RouteResult]
Bubbles the given error up the response chain where it is dealt with by the closest
handleExceptionsdirective and itsExceptionHandler, unless the error is aRejectionError.Bubbles the given error up the response chain where it is dealt with by the closest
handleExceptionsdirective and itsExceptionHandler, unless the error is aRejectionError. In this case the wrapped rejection is unpacked and "executed". - abstract def log: LoggingAdapter
The default LoggingAdapter to be used for logging messages related to this request.
- abstract def mapRequest(f: (HttpRequest) => HttpRequest): RequestContext
Returns a copy of this context with the HttpRequest transformed by the given function.
- abstract def mapUnmatchedPath(f: (Path) => Path): RequestContext
Returns a copy of this context with the unmatchedPath transformed by the given function.
- implicit abstract def materializer: Materializer
The default Materializer.
- abstract def parserSettings: ParserSettings
The default ParserSettings to be used for configuring directives.
- 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.
- abstract def redirect(uri: Uri, redirectionType: Redirection): Future[RouteResult]
Completes the request with redirection response of the given type to the given URI.
- abstract def reject(rejections: Rejection*): Future[RouteResult]
Rejects the request with the given rejections.
- abstract val request: HttpRequest
The request this context represents.
The request this context represents. Modelled as a
valso as to enable animport ctx.request._. - abstract def settings: RoutingSettings
The default RoutingSettings to be used for configuring directives.
- abstract val unmatchedPath: Path
The unmatched path of this context.
The unmatched path of this context. Modelled as a
valso as to enable animport ctx.unmatchedPath._. - abstract def withAcceptAll: RequestContext
Removes a potentially existing Accept header from the request headers.
- abstract def withExecutionContext(ec: ExecutionContextExecutor): RequestContext
Returns a copy of this context with the new HttpRequest.
- abstract def withLog(log: LoggingAdapter): RequestContext
Returns a copy of this context with the new LoggingAdapter.
- abstract def withMaterializer(materializer: Materializer): RequestContext
Returns a copy of this context with the new HttpRequest.
- abstract def withParserSettings(settings: ParserSettings): RequestContext
Returns a copy of this context with the new pekko.http.scaladsl.settings.ParserSettings.
- abstract def withRequest(req: HttpRequest): RequestContext
Returns a copy of this context with the new HttpRequest.
- abstract def withRoutingSettings(settings: RoutingSettings): RequestContext
Returns a copy of this context with the new RoutingSettings.
- abstract def withUnmatchedPath(path: Path): RequestContext
Returns a copy of this context with the unmatched path updated to the given one.
Concrete 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 RequestContext toany2stringadd[RequestContext] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- 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
- 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
- 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
- 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 hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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 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 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): (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.