trait UrlAndHeaders[A] extends AnyRef
The URL and HTTP headers of a request.
- Self Type
- UrlAndHeaders[A]
- Source
- Endpoints.scala
- Alphabetic
- By Inheritance
- UrlAndHeaders
- AnyRef
- Any
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def decode: EndpointsWithCustomErrors.RequestExtractor[Validated[A]]
Attempts to extract an
A
from an incoming request.Attempts to extract an
A
from an incoming request.Two kinds of situations can happen: 1. The incoming request URL does not match
this
definition: nothing is extracted (theRequestExtractor
returnsNone
) ; 2. The incoming request URL matchesthis
definition but the headers or parameters are erroneous: theRequestExtractor
returns aSome(Invalid(...))
. - abstract def encode(a: A): Call
Reverse routing.
Reverse routing.
- a
Information carried by the request URL and headers
- returns
The URL and HTTP verb matching the
a
value.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (UrlAndHeaders[A], B)
- Implicit
- This member is added by an implicit conversion from UrlAndHeaders[A] toArrowAssoc[UrlAndHeaders[A]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- 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]) @native()
- def ensuring(cond: (UrlAndHeaders[A]) => Boolean, msg: => Any): UrlAndHeaders[A]
- Implicit
- This member is added by an implicit conversion from UrlAndHeaders[A] toEnsuring[UrlAndHeaders[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (UrlAndHeaders[A]) => Boolean): UrlAndHeaders[A]
- Implicit
- This member is added by an implicit conversion from UrlAndHeaders[A] toEnsuring[UrlAndHeaders[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): UrlAndHeaders[A]
- Implicit
- This member is added by an implicit conversion from UrlAndHeaders[A] toEnsuring[UrlAndHeaders[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): UrlAndHeaders[A]
- Implicit
- This member is added by an implicit conversion from UrlAndHeaders[A] toEnsuring[UrlAndHeaders[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from UrlAndHeaders[A] toStringFormat[UrlAndHeaders[A]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @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
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toRequest[B](toB: (A) => BodyParser[B])(toA: (B) => A): Request[B]
Promotes
this
to aRequest[B]
.Promotes
this
to aRequest[B]
.- toB
Function defining how to get a
BodyParser[B]
from the extractedA
- toA
Function defining how to get back an
A
from theB
.
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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]) @native()
Deprecated Value Members
- def →[B](y: B): (UrlAndHeaders[A], B)
- Implicit
- This member is added by an implicit conversion from UrlAndHeaders[A] toArrowAssoc[UrlAndHeaders[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.