trait Request[A] extends AnyRef
- Alphabetic
- By Inheritance
- Request
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- abstract type UrlAndHeaders
Information extracted from the URL and the headers
Abstract Value Members
- 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.
- 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).
- abstract def uri(a: A): Uri
The URI of a request carrying the given
a
parameter
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Request[A], B)
- 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(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- 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).
- def ensuring(cond: (Request[A]) => Boolean, msg: => Any): Request[A]
- def ensuring(cond: (Request[A]) => Boolean): Request[A]
- def ensuring(cond: Boolean, msg: => Any): Request[A]
- def ensuring(cond: Boolean): Request[A]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @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
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.