org.apache.pekko.http.scaladsl.server.directives
RouteDirectives
Companion object RouteDirectives
trait RouteDirectives extends AnyRef
- Grouped
- Alphabetic
- By Inheritance
- RouteDirectives
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
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 RouteDirectives to any2stringadd[RouteDirectives] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (RouteDirectives, B)
- Implicit
- This member is added by an implicit conversion from RouteDirectives to ArrowAssoc[RouteDirectives] 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( ... ) @native()
-
def
complete[T](status: StatusCode, headers: Seq[HttpHeader], v: ⇒ T)(implicit m: ToEntityMarshaller[T]): StandardRoute
Completes the request using the given arguments.
-
def
complete[T](status: StatusCode, v: ⇒ T)(implicit m: ToEntityMarshaller[T]): StandardRoute
Completes the request using the given arguments.
-
def
complete(m: ⇒ ToResponseMarshallable): StandardRoute
Completes the request using the given arguments.
-
def
ensuring(cond: (RouteDirectives) ⇒ Boolean, msg: ⇒ Any): RouteDirectives
- Implicit
- This member is added by an implicit conversion from RouteDirectives to Ensuring[RouteDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (RouteDirectives) ⇒ Boolean): RouteDirectives
- Implicit
- This member is added by an implicit conversion from RouteDirectives to Ensuring[RouteDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): RouteDirectives
- Implicit
- This member is added by an implicit conversion from RouteDirectives to Ensuring[RouteDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): RouteDirectives
- Implicit
- This member is added by an implicit conversion from RouteDirectives to Ensuring[RouteDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
failWith(error: Throwable): StandardRoute
Bubbles the given error up the response chain, where it is dealt with by the closest
handleExceptionsdirective and its ExceptionHandler. -
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
handle(handler: PartialFunction[HttpRequest, Future[HttpResponse]], rejections: Seq[Rejection]): StandardRoute
Handle the request using an asynchronous partial function.
Handle the request using an asynchronous partial function.
This directive can be used to include external components request processing components defined as PartialFunction (like those provided by pekko-grpc) into a routing tree defined as routes.
- rejections
The list of rejections to reject with if the handler is not defined for a request.
-
def
handle(handler: PartialFunction[HttpRequest, Future[HttpResponse]]): StandardRoute
Handle the request using an asynchronous partial function.
Handle the request using an asynchronous partial function.
This directive can be used to include external components request processing components defined as PartialFunction (like those provided by pekko-grpc) into a routing tree defined as routes.
When the partial function is not defined for a request, the request is rejected with an empty list of rejections which is equivalent to a "Not Found" rejection.
-
def
handle(handler: (HttpRequest) ⇒ Future[HttpResponse]): StandardRoute
Handle the request using a function.
-
def
handleSync(handler: PartialFunction[HttpRequest, HttpResponse], rejections: Seq[Rejection]): StandardRoute
Handle the request using a synchronous partial function.
Handle the request using a synchronous partial function.
This directive can be used to include external components request processing components defined as PartialFunction (like those provided by pekko-grpc) into a routing tree defined as routes.
- rejections
The list of rejections to reject with if the handler is not defined for a request.
-
def
handleSync(handler: PartialFunction[HttpRequest, HttpResponse]): StandardRoute
Handle the request using a synchronous partial function.
Handle the request using a synchronous partial function.
This directive can be used to include external components request processing components defined as PartialFunction (like those provided by pekko-grpc) into a routing tree defined as routes.
When the partial function is not defined for a request, the request is rejected with an empty list of rejections which is equivalent to a "Not Found" rejection.
-
def
handleSync(handler: (HttpRequest) ⇒ HttpResponse): StandardRoute
Handle the request using a function.
-
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()
-
def
redirect(uri: Uri, redirectionType: Redirection): StandardRoute
Completes the request with redirection response of the given type to the given URI.
-
def
reject(rejections: Rejection*): StandardRoute
Rejects the request with the given rejections.
-
def
reject: StandardRoute
Rejects the request with an empty set of rejections.
-
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( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
→[B](y: B): (RouteDirectives, B)
- Implicit
- This member is added by an implicit conversion from RouteDirectives to ArrowAssoc[RouteDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Deprecated Value Members
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from RouteDirectives to StringFormat[RouteDirectives] 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.