Packages

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

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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. 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.

    Alias for and.

  4. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Directive[L] toany2stringadd[Directive[L]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ->[B](y: B): (Directive[L], B)
    Implicit
    This member is added by an implicit conversion from Directive[L] toArrowAssoc[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
    Definition Classes
    AnyRef → Any
  7. def and(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.

  8. 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
  9. 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
  10. 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).

  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  13. 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] toSingleValueTransformers[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
  14. 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()
  15. 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()
  16. def ensuring(cond: (Directive[L]) => Boolean, msg: => Any): Directive[L]
    Implicit
    This member is added by an implicit conversion from Directive[L] toEnsuring[Directive[L]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (Directive[L]) => Boolean): Directive[L]
    Implicit
    This member is added by an implicit conversion from Directive[L] toEnsuring[Directive[L]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: => Any): Directive[L]
    Implicit
    This member is added by an implicit conversion from Directive[L] toEnsuring[Directive[L]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): Directive[L]
    Implicit
    This member is added by an implicit conversion from Directive[L] toEnsuring[Directive[L]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. implicit val ev: Tuple[L]
  23. def filter(predicate: (T) => Boolean, rejections: Rejection*): Directive1[T]
    Implicit
    This member is added by an implicit conversion from Directive[L] toSingleValueTransformers[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
  24. 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] toSingleValueTransformers[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
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def map[R](f: (T) => R)(implicit tupler: Tupler[R]): Directive[Out]
    Implicit
    This member is added by an implicit conversion from Directive[L] toSingleValueTransformers[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
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. def or[R >: L](that: Directive[R]): Directive[R]

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

  33. 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**.

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

  35. def require(predicate: (T) => Boolean, rejections: Rejection*): Directive0
    Implicit
    This member is added by an implicit conversion from Directive[L] toSingleValueTransformers[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
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. 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.

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

  39. def tflatMap[R](f: (L) => Directive[R])(implicit arg0: Tuple[R]): Directive[R]

    Flatmaps this directive using the given function.

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

  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. 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.

  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. def wrap[R](f: => Directive[R]): Directive[R]
    Implicit
    This member is added by an implicit conversion from Directive[L] toDirective0Support 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
  47. def |[R >: L](that: Directive[R]): Directive[R]

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

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

    Alias for or.

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] toSingleValueTransformers[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] toDirective0Support 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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Directive[L] toStringFormat[Directive[L]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Directive[L], B)
    Implicit
    This member is added by an implicit conversion from Directive[L] toArrowAssoc[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
    @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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion SingleValueTransformers fromDirective[L] to SingleValueTransformers[T]

Inherited by implicit conversion Directive0Support fromDirective[L] to Directive0Support

Inherited by implicit conversion addByNameNullaryApply fromDirective[L] to (=> Route) => Route

Inherited by implicit conversion addDirectiveApply fromDirective[L] to (In) => Route

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

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

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

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

Ungrouped