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
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Directive
  2. AnyRef
  3. Any
Implicitly
  1. by addByNameNullaryApply
  2. by addDirectiveApply
  3. by SingleValueTransformers
  4. by Directive0Support
  5. by any2stringadd
  6. by StringFormat
  7. by Ensuring
  8. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

Abstract Value Members

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

    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. def &(magnet: ConjunctionMagnet[L]): Out

    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.

  2. def apply(v1: ⇒ Route): Route
    Implicit
    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
  3. def apply(v1: In): Route
    Implicit
    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
  4. def as[A](constructor: ConstructFromTuple[L, A]): Directive1[A]

    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).

  5. def collect[R](pf: PartialFunction[T, R], rejections: Rejection*)(implicit tupler: Tupler[R]): Directive[Out]
    Implicit
    This member is added by an implicit conversion from Directive[L] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    SingleValueTransformers
  6. def compose[A](g: (A) ⇒ ⇒ Route): (A) ⇒ Route
    Implicit
    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()
  7. def compose[A](g: (A) ⇒ In): (A) ⇒ Route
    Implicit
    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()
  8. implicit val ev: Tuple[L]
  9. def filter(predicate: (T) ⇒ Boolean, rejections: Rejection*): Directive1[T]
    Implicit
    This member is added by an implicit conversion from Directive[L] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    SingleValueTransformers
  10. def flatMap[R](f: (T) ⇒ Directive[R])(implicit arg0: Tuple[R]): Directive[R]
    Implicit
    This member is added by an implicit conversion from Directive[L] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    SingleValueTransformers
  11. def map[R](f: (T) ⇒ R)(implicit tupler: Tupler[R]): Directive[Out]
    Implicit
    This member is added by an implicit conversion from Directive[L] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    SingleValueTransformers
  12. def recover[R >: L](recovery: (Seq[Rejection]) ⇒ Directive[R])(implicit arg0: Tuple[R]): Directive[R]

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

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

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

  14. def require(predicate: (T) ⇒ Boolean, rejections: Rejection*): Directive0
    Implicit
    This member is added by an implicit conversion from Directive[L] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    SingleValueTransformers
  15. def tcollect[R](pf: PartialFunction[L, R], rejections: Rejection*)(implicit tupler: Tupler[R]): Directive[Out]

    If the given scala.PartialFunction is defined for the input, maps this directive with the given function, which can produce either a tuple or any other value.

    If the given scala.PartialFunction is defined for the input, maps this directive with the given function, which can produce either a tuple or any other value. If it is not defined however, the returned directive will reject with the given rejections.

  16. def tfilter(predicate: (L) ⇒ Boolean, rejections: Rejection*): Directive[L]

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

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

    Flatmaps this directive using the given function.

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

    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).

  19. def trequire(predicate: (L) ⇒ Boolean, rejections: Rejection*): Directive0

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

  20. def wrap[R](f: ⇒ Directive[R]): Directive[R]
    Implicit
    This member is added by an implicit conversion from Directive[L] to Directive0Support performed by method Directive0Support in akka.http.scaladsl.server.Directive. This conversion will take place only if L is Unit (L =:= Unit).
    Definition Classes
    Directive0Support
  21. def |[R >: L](that: Directive[R]): Directive[R]

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

Shadowed Implicit Value Members

  1. def andThen[A](g: (Route) ⇒ A): (⇒ Route) ⇒ A
    Implicit
    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
    Implicit
    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
    Implicit
    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
    Implicit
    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
  5. val underlying: Directive1[T]
    Implicit
    This member is added by an implicit conversion from Directive[L] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive. This conversion will take place only if L is (T) (L =:= (T)).
    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: SingleValueTransformers[T]).underlying
    Definition Classes
    SingleValueTransformers
  6. val underlying: Directive0
    Implicit
    This member is added by an implicit conversion from Directive[L] to Directive0Support performed by method Directive0Support 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: Directive0Support).underlying
    Definition Classes
    Directive0Support