Class/Object

akka.http.scaladsl.server

Directive

Related Docs: object Directive | package server

Permalink

abstract class Directive[L] extends AnyRef

A directive that provides a tuple of values of type L to create an inner route.

Source
Directive.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Directive
  2. AnyRef
  3. Any
Implicitly
  1. by addByNameNullaryApply
  2. by addDirectiveApply
  3. by SingleValueModifiers
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Directive()(implicit ev: Tuple[L])

    Permalink

Abstract Value Members

  1. abstract def tapply(f: (L) ⇒ Route): Route

    Permalink

    Calls the inner route with a tuple of extracted values of type L.

    Calls the inner route with a tuple of extracted values of type L.

    tapply is short for "tuple-apply". Usually, you will use the regular apply method instead, which is added by an implicit conversion (see Directive.addDirectiveApply).

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def &(magnet: ConjunctionMagnet[L]): Out

    Permalink

    Joins two directives into one which extracts the concatenation of its base directive extractions.

    Joins two directives into one which extracts the concatenation of its base directive extractions. NOTE: Extraction joining is an O(N) operation with N being the number of extractions on the right-side.

  4. def +(other: String): String

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to ArrowAssoc[Directive[L]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if L is a superclass of Any and a subclass of Unit with (Nothing) (L >: Any <: Unit with (Nothing)).
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  7. def apply(v1: ⇒ Route): Route

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to (⇒ Route) ⇒ Route performed by method addByNameNullaryApply in akka.http.scaladsl.server.Directive. This conversion will take place only if L is Unit (L =:= Unit).
    Definition Classes
    Function1
  8. def apply(v1: In): Route

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to (In) ⇒ Route performed by method addDirectiveApply in akka.http.scaladsl.server.Directive. This conversion will take place only if L is context-bounded by akka.http.scaladsl.server.util.ApplyConverter (L: ApplyConverter).
    Definition Classes
    Function1
  9. def as[A](constructor: ConstructFromTuple[L, A]): Directive1[A]

    Permalink

    Converts this directive into one which, instead of a tuple of type L, creates an instance of type A (which is usually a case class).

  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def compose[A](g: (A) ⇒ ⇒ Route): (A) ⇒ Route

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to (⇒ Route) ⇒ Route performed by method addByNameNullaryApply in akka.http.scaladsl.server.Directive. This conversion will take place only if L is Unit (L =:= Unit).
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  13. def compose[A](g: (A) ⇒ In): (A) ⇒ Route

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to (In) ⇒ Route performed by method addDirectiveApply in akka.http.scaladsl.server.Directive. This conversion will take place only if L is context-bounded by akka.http.scaladsl.server.util.ApplyConverter (L: ApplyConverter).
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  14. def ensuring(cond: (Directive[L]) ⇒ Boolean, msg: ⇒ Any): Directive[L]

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. implicit val ev: Tuple[L]

    Permalink
  21. def filter(predicate: (T) ⇒ Boolean, rejections: Rejection*): Directive1[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to SingleValueModifiers[T] performed by method SingleValueModifiers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    SingleValueModifiers
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def flatMap[R](f: (T) ⇒ Directive[R])(implicit arg0: Tuple[R]): Directive[R]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to SingleValueModifiers[T] performed by method SingleValueModifiers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    SingleValueModifiers
  24. def formatted(fmtstr: String): String

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

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

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

    Permalink
    Definition Classes
    Any
  28. def map[R](f: (T) ⇒ R)(implicit tupler: Tupler[R]): Directive[Out]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to SingleValueModifiers[T] performed by method SingleValueModifiers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    SingleValueModifiers
  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. def recover[R >: L](recovery: (Seq[Rejection]) ⇒ Directive[R])(implicit arg0: Tuple[R]): Directive[R]

    Permalink

    Creates a new directive that is able to recover from rejections that were produced by this Directive **before the inner route was applied**.

  33. def recoverPF[R >: L](recovery: PartialFunction[Seq[Rejection], Directive[R]])(implicit arg0: Tuple[R]): Directive[R]

    Permalink

    Variant of recover that only recovers from rejections handled by the given PartialFunction.

  34. def require(predicate: (T) ⇒ Boolean, rejections: Rejection*): Directive0

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to SingleValueModifiers[T] performed by method SingleValueModifiers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    SingleValueModifiers
  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  36. def tfilter(predicate: (L) ⇒ Boolean, rejections: Rejection*): Directive[L]

    Permalink

    Creates a new directive of the same type, which passes if the given predicate matches the current extractions or rejects with the given rejections.

  37. def tflatMap[R](f: (L) ⇒ Directive[R])(implicit arg0: Tuple[R]): Directive[R]

    Permalink

    Flatmaps this directive using the given function.

  38. def tmap[R](f: (L) ⇒ R)(implicit tupler: Tupler[R]): Directive[Out]

    Permalink

    Maps over this directive using the given function, which can produce either a tuple or any other value (which will then we wrapped into a scala.Tuple1).

  39. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  40. def trequire(predicate: (L) ⇒ Boolean, rejections: Rejection*): Directive0

    Permalink

    Creates a new akka.http.scaladsl.server.Directive0, which passes if the given predicate matches the current extractions or rejects with the given rejections.

  41. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def |[R >: L](that: Directive[R]): Directive[R]

    Permalink

    Joins two directives into one which runs the second directive if the first one rejects.

  45. def [B](y: B): (Directive[L], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to ArrowAssoc[Directive[L]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if L is a superclass of Any and a subclass of Unit with (Nothing) (L >: Any <: Unit with (Nothing)).
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def andThen[A](g: (Route) ⇒ A): (⇒ Route) ⇒ A

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to (⇒ Route) ⇒ Route performed by method addByNameNullaryApply in akka.http.scaladsl.server.Directive. This conversion will take place only if L is Unit (L =:= Unit).
    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:
    (directive: (⇒ Route) ⇒ Route).andThen(g)
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  2. def andThen[A](g: (Route) ⇒ A): (In) ⇒ A

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to (In) ⇒ Route performed by method addDirectiveApply in akka.http.scaladsl.server.Directive. This conversion will take place only if L is context-bounded by akka.http.scaladsl.server.util.ApplyConverter (L: ApplyConverter).
    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:
    (directive: (In) ⇒ Route).andThen(g)
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  3. def toString(): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to (⇒ Route) ⇒ Route performed by method addByNameNullaryApply in akka.http.scaladsl.server.Directive. This conversion will take place only if L is Unit (L =:= Unit).
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (directive: (⇒ Route) ⇒ Route).toString()
    Definition Classes
    Function1 → AnyRef → Any
  4. def toString(): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Directive[L] to (In) ⇒ Route performed by method addDirectiveApply in akka.http.scaladsl.server.Directive. This conversion will take place only if L is context-bounded by akka.http.scaladsl.server.util.ApplyConverter (L: ApplyConverter).
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (directive: (In) ⇒ Route).toString()
    Definition Classes
    Function1 → AnyRef → Any

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion addByNameNullaryApply from Directive[L] to (⇒ Route) ⇒ Route

Inherited by implicit conversion addDirectiveApply from Directive[L] to (In) ⇒ Route

Inherited by implicit conversion SingleValueModifiers from Directive[L] to SingleValueModifiers[T]

Inherited by implicit conversion any2stringadd from Directive[L] to any2stringadd[Directive[L]]

Inherited by implicit conversion StringFormat from Directive[L] to StringFormat[Directive[L]]

Inherited by implicit conversion Ensuring from Directive[L] to Ensuring[Directive[L]]

Inherited by implicit conversion ArrowAssoc from Directive[L] to ArrowAssoc[Directive[L]]

Ungrouped