akka.http.scaladsl.server

RequestContext

trait RequestContext extends AnyRef

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

Source
RequestContext.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RequestContext
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Completes the request with the given ToResponseMarshallable.

  2. implicit abstract def executionContext: ExecutionContext

    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 reconfigure(executionContext: ExecutionContext = executionContext, materializer: Materializer = materializer, log: LoggingAdapter = log, settings: RoutingSettings = settings): RequestContext

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

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

    Rejects the request with the given rejections.

  10. 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._.

  11. abstract def settings: RoutingSettings

    The default RoutingSettings to be used for configuring directives.

  12. 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._.

  13. abstract def withAcceptAll: RequestContext

    Removes a potentially existing Accept header from the request headers.

  14. abstract def withExecutionContext(ec: ExecutionContext): RequestContext

    Returns a copy of this context with the new HttpRequest.

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

    Returns a copy of this context with the new LoggingAdapter.

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

    Returns a copy of this context with the new HttpRequest.

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

    Returns a copy of this context with the new HttpRequest.

  18. abstract def withSettings(settings: RoutingSettings): RequestContext

    Returns a copy of this context with the new RoutingSettings.

  19. 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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from RequestContext to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (RequestContext, B)

    Implicit information
    This member is added by an implicit conversion from RequestContext to ArrowAssoc[RequestContext] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (RequestContext) ⇒ Boolean, msg: ⇒ Any): RequestContext

    Implicit information
    This member is added by an implicit conversion from RequestContext to Ensuring[RequestContext] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (RequestContext) ⇒ Boolean): RequestContext

    Implicit information
    This member is added by an implicit conversion from RequestContext to Ensuring[RequestContext] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): RequestContext

    Implicit information
    This member is added by an implicit conversion from RequestContext to Ensuring[RequestContext] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): RequestContext

    Implicit information
    This member is added by an implicit conversion from RequestContext to Ensuring[RequestContext] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from RequestContext to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (RequestContext, B)

    Implicit information
    This member is added by an implicit conversion from RequestContext to ArrowAssoc[RequestContext] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from RequestContext to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (requestContext: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from RequestContext to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (requestContext: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: RequestContext

    Implicit information
    This member is added by an implicit conversion from RequestContext to ArrowAssoc[RequestContext] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (requestContext: ArrowAssoc[RequestContext]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: RequestContext

    Implicit information
    This member is added by an implicit conversion from RequestContext to Ensuring[RequestContext] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (requestContext: Ensuring[RequestContext]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from RequestContext to StringAdd

Inherited by implicit conversion any2stringfmt from RequestContext to StringFormat

Inherited by implicit conversion any2ArrowAssoc from RequestContext to ArrowAssoc[RequestContext]

Inherited by implicit conversion any2Ensuring from RequestContext to Ensuring[RequestContext]

Ungrouped