Packages

trait Request[A] extends AnyRef

An HTTP request.

Has an instance of InvariantFunctor.

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 EntityData
  2. abstract type HeadersData
  3. abstract type UrlData

Abstract Value Members

  1. abstract def aggregateAndValidate(urlData: UrlData, headersData: HeadersData, entityData: EntityData): Validated[A]
  2. abstract def entity: RequestEntity[EntityData]

    The entity of this request

  3. abstract def headers: RequestHeaders[HeadersData]

    The headers component of this request

  4. abstract def matchRequest(requestHeader: RequestHeader): Option[RequestEntity[A]]

    Returns a RequestEntity[A] (that is, a way to decode the entity of the incoming request) if the incoming request matches the method and URL of this request description.

  5. abstract def method: EndpointsWithCustomErrors.Method

    The method of this request

  6. abstract def url: EndpointsWithCustomErrors.Url[UrlData]

    The URL component of this request

  7. abstract def urlData(a: A): UrlData

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 def encode(a: A): Call

    Reverse routing.

    Reverse routing.

    a

    Information carried by the request

    returns

    The URL and HTTP verb matching the a value.

  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 matchRequestAndParseHeaders(requestHeader: RequestHeader)(entity: (UrlData, HeadersData) => RequestEntity[A]): Option[RequestEntity[A]]

    returns

    If the incoming requestHeader match this request description (the method and URL), validate the request URL parameters and headers. Otherwise, returns None.

    Attributes
    protected
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. 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