Packages

trait Request[A] extends AnyRef

Source
Endpoints.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Request
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type UrlAndHeaders

    Information extracted from the URL and the headers

Abstract Value Members

  1. abstract def matchAndParseHeadersDirective: Directive1[Validated[UrlAndHeaders]]

    Checks whether the incoming request matches this request description, and if this is the case, parses its URL parameters and headers.

    Checks whether the incoming request matches this request description, and if this is the case, parses its URL parameters and headers.

    The directive produces:

    • a rejection to signal that the incoming request does not match this request description,
    • a completion to immediately return a custom response (e.g. 401),
    • a value Valid(urlAndHeadersData) in case the URL and headers were successfully parsed,
    • a value Invalid(errors) in case the URL and headers had validation errors.
  2. abstract def parseEntityDirective(urlAndHeaders: UrlAndHeaders): Directive1[A]

    Parses the request entity.

    Parses the request entity.

    The directive produces:

    • a completion to immediately return a custom response,
    • or, a value of type A containing all the information extracted from the request (including URL, headers, and entity).
  3. abstract def uri(a: A): Uri

    The URI of a request carrying the given a parameter

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Request[A] toany2stringadd[Request[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Request[A], B)
    Implicit
    This member is added by an implicit conversion from Request[A] toArrowAssoc[Request[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. final lazy val directive: Directive1[A]

    Directive matching and parsing the content of an incoming request.

    Directive matching and parsing the content of an incoming request.

    First, it checks whether the incoming request matches the request URL and method. If this is the case, it parses the request headers and proceeds to the second step.

    If there were no validation errors when parsing the request URL and headers, it parses the request entity.

    The directive can produce:

    • a rejection to signal that the incoming request does not match this request description,
    • a completion containing an error response (e.g., in case of validation errors),
    • a value of type A parsed from the request content (URL, headers, and entity).
  9. def ensuring(cond: (Request[A]) => Boolean, msg: => Any): Request[A]
    Implicit
    This member is added by an implicit conversion from Request[A] toEnsuring[Request[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Request[A]) => Boolean): Request[A]
    Implicit
    This member is added by an implicit conversion from Request[A] toEnsuring[Request[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): Request[A]
    Implicit
    This member is added by an implicit conversion from Request[A] toEnsuring[Request[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Request[A]
    Implicit
    This member is added by an implicit conversion from Request[A] toEnsuring[Request[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Request[A] toStringFormat[Request[A]] 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): (Request[A], B)
    Implicit
    This member is added by an implicit conversion from Request[A] toArrowAssoc[Request[A]] performed by method ArrowAssoc in scala.Predef.
    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 any2stringadd fromRequest[A] to any2stringadd[Request[A]]

Inherited by implicit conversion StringFormat fromRequest[A] to StringFormat[Request[A]]

Inherited by implicit conversion Ensuring fromRequest[A] to Ensuring[Request[A]]

Inherited by implicit conversion ArrowAssoc fromRequest[A] to ArrowAssoc[Request[A]]

Ungrouped