final case class Request(version: Version = Version.Default, method: Method = Method.ANY, url: URL = URL.empty, headers: Headers = Headers.empty, body: Body = Body.empty, remoteAddress: Option[InetAddress] = None, remoteCertificate: Option[Certificate] = None) extends HeaderOps[Request] with QueryOps[Request] with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Request
  2. Serializable
  3. Product
  4. Equals
  5. QueryOps
  6. QueryChecks
  7. QueryGetters
  8. QueryModifier
  9. HeaderOps
  10. HeaderChecks
  11. HeaderGetters
  12. HeaderModifier
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Request(version: Version = Version.Default, method: Method = Method.ANY, url: URL = URL.empty, headers: Headers = Headers.empty, body: Body = Body.empty, remoteAddress: Option[InetAddress] = None, remoteCertificate: Option[Certificate] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ++(that: Request): Request

    A right-biased way of combining two requests.

    A right-biased way of combining two requests. Most information will be merged, but in cases where this does not make sense (e.g. two non-empty bodies), the information from the right request will be used.

  4. def ++(that: QueryParams): Request

    Combines two collections of query parameters together.

    Combines two collections of query parameters together. If there are duplicate keys, the values from both sides are preserved, in order from left-to-right.

    Definition Classes
    QueryModifier
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def addHeader(name: CharSequence, value: CharSequence): Request
    Definition Classes
    HeaderModifier
  7. final def addHeader(header: Header): Request
    Definition Classes
    HeaderModifier
  8. final def addHeaders(headers: Headers): Request
    Definition Classes
    HeaderModifier
  9. def addLeadingSlash: Request
  10. def addQueryParam(key: String, value: String): Request

    Adds the specified key/value pair to the query parameters.

    Adds the specified key/value pair to the query parameters.

    Definition Classes
    QueryModifier
  11. def addQueryParams(values: String): Request
    Definition Classes
    QueryModifier
  12. def addQueryParams(key: String, value: Chunk[String]): Request

    Adds the specified key/value pairs to the query parameters.

    Adds the specified key/value pairs to the query parameters.

    Definition Classes
    QueryModifier
  13. def addTrailingSlash: Request

    Add trailing slash to the path.

  14. lazy val allHeaders: Headers

    Custom headers and headers required by the used Body

  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. val body: Body
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  18. def collect(implicit trace: Trace): ZIO[Any, Throwable, Request]

    Collects the potentially streaming body of the request into a single chunk.

  19. def cookie(name: String): Option[Cookie]

    Returns the cookie with the given name if it exists.

  20. def cookieWithOrFail[R, E, A](name: String)(missingCookieError: E)(f: (Cookie) => ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Uses the cookie with the given name if it exists and runs f with the cookie afterwards.

    Uses the cookie with the given name if it exists and runs f with the cookie afterwards.

    Also, you can set a custom failure value from a missing cookie with E.

  21. def cookieWithZIO[R, A](name: String)(f: (Cookie) => ZIO[R, Throwable, A])(implicit trace: Trace): ZIO[R, Throwable, A]

    Uses the cookie with the given name if it exists and runs f with the cookie afterwards.

  22. def cookies: Chunk[Cookie]

    Returns all cookies from the request.

  23. def dropLeadingSlash: Request
  24. def dropTrailingSlash: Request

    Drops trailing slash from the path.

  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def flash[A](flash: Flash[A]): Option[A]

    Returns an A if it exists from the cookie-based flash-scope.

  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  28. final def hasContentType(value: CharSequence): Boolean
    Definition Classes
    HeaderChecks
  29. final def hasFormMultipartContentType: Boolean
    Definition Classes
    HeaderChecks
  30. final def hasFormUrlencodedContentType: Boolean
    Definition Classes
    HeaderChecks
  31. final def hasHeader(header: Header): Boolean
    Definition Classes
    HeaderChecks
  32. final def hasHeader(headerType: HeaderType): Boolean
    Definition Classes
    HeaderChecks
  33. final def hasHeader(name: CharSequence): Boolean
    Definition Classes
    HeaderChecks
  34. final def hasJsonContentType: Boolean
    Definition Classes
    HeaderChecks
  35. final def hasMediaType(mediaType: MediaType): Boolean
    Definition Classes
    HeaderChecks
  36. def hasQueryParam(name: CharSequence): Boolean
    Definition Classes
    QueryChecks
  37. final def hasTextPlainContentType: Boolean
    Definition Classes
    HeaderChecks
  38. final def hasXhtmlXmlContentType: Boolean
    Definition Classes
    HeaderChecks
  39. final def hasXmlContentType: Boolean
    Definition Classes
    HeaderChecks
  40. final def header(headerType: HeaderType): Option[HeaderValue]

    Gets a header or returns None if the header was not present or it could not be parsed

    Gets a header or returns None if the header was not present or it could not be parsed

    Definition Classes
    HeaderGetters
  41. final def headerOrFail(headerType: HeaderType): Option[Either[String, HeaderValue]]

    Gets a header.

    Gets a header. If the header is not present, returns None. If the header could not be parsed it returns the parsing error

    Definition Classes
    HeaderGetters
  42. final def headers(headerType: HeaderType): Chunk[HeaderValue]
    Definition Classes
    HeaderGetters
  43. val headers: Headers

    Returns the headers

    Returns the headers

    Definition Classes
    Request → HeaderGetters
  44. def ignoreBody(implicit trace: Trace): ZIO[Any, Throwable, Request]

    Consumes the streaming body fully and then drops it

  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. val method: Method
  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  50. def patch(p: Patch): Request
  51. def path(path: Path): Request
  52. def path: Path
  53. def productElementNames: Iterator[String]
    Definition Classes
    Product
  54. def queryParam(key: String): Option[String]

    Retrieves the first query parameter value having the specified name.

    Retrieves the first query parameter value having the specified name.

    Definition Classes
    QueryGetters
  55. def queryParamOrElse(key: String, default: => String): String

    Retrieves the first query parameter value having the specified name, or else uses the default value.

    Retrieves the first query parameter value having the specified name, or else uses the default value.

    Definition Classes
    QueryGetters
  56. def queryParamTo[T](key: String)(implicit codec: TextCodec[T]): Either[QueryParamsError, T]

    Retrieves the first typed query parameter value having the specified name.

    Retrieves the first typed query parameter value having the specified name.

    Definition Classes
    QueryGetters
  57. def queryParamToOrElse[T](key: String, default: => T)(implicit codec: TextCodec[T]): T

    Retrieves the first typed query parameter value having the specified name, or else uses the default value.

    Retrieves the first typed query parameter value having the specified name, or else uses the default value.

    Definition Classes
    QueryGetters
  58. def queryParamToZIO[T](key: String)(implicit codec: TextCodec[T]): IO[QueryParamsError, T]

    Retrieves the first typed query parameter value having the specified name as ZIO.

    Retrieves the first typed query parameter value having the specified name as ZIO.

    Definition Classes
    QueryGetters
  59. def queryParameters: QueryParams
    Definition Classes
    Request → QueryGetters
  60. def queryParams(key: String): Chunk[String]

    Retrieves all query parameter values having the specified name.

    Retrieves all query parameter values having the specified name.

    Definition Classes
    QueryGetters
  61. def queryParamsOrElse(key: String, default: => Iterable[String]): Chunk[String]

    Retrieves all query parameter values having the specified name, or else uses the default iterable.

    Retrieves all query parameter values having the specified name, or else uses the default iterable.

    Definition Classes
    QueryGetters
  62. def queryParamsTo[T](key: String)(implicit codec: TextCodec[T]): Either[QueryParamsError, Chunk[T]]

    Retrieves all typed query parameter values having the specified name.

    Retrieves all typed query parameter values having the specified name.

    Definition Classes
    QueryGetters
  63. def queryParamsToOrElse[T](key: String, default: => Iterable[T])(implicit codec: TextCodec[T]): Chunk[T]

    Retrieves all query parameter values having the specified name, or else uses the default iterable.

    Retrieves all query parameter values having the specified name, or else uses the default iterable.

    Definition Classes
    QueryGetters
  64. def queryParamsToZIO[T](key: String)(implicit codec: TextCodec[T]): IO[QueryParamsError, Chunk[T]]

    Retrieves all typed query parameter values having the specified name as ZIO.

    Retrieves all typed query parameter values having the specified name as ZIO.

    Definition Classes
    QueryGetters
  65. final def rawHeader(headerType: HeaderType): Option[String]

    Gets the raw unparsed header value

    Gets the raw unparsed header value

    Definition Classes
    HeaderGetters
  66. final def rawHeader(name: CharSequence): Option[String]

    Gets the raw unparsed header value

    Gets the raw unparsed header value

    Definition Classes
    HeaderGetters
  67. val remoteAddress: Option[InetAddress]
  68. val remoteCertificate: Option[Certificate]
  69. final def removeHeader(name: String): Request
    Definition Classes
    HeaderModifier
  70. final def removeHeader(headerType: HeaderType): Request
    Definition Classes
    HeaderModifier
  71. final def removeHeaders(headers: Set[String]): Request
    Definition Classes
    HeaderModifier
  72. def removeQueryParam(key: String): Request

    Removes the specified key from the query parameters.

    Removes the specified key from the query parameters.

    Definition Classes
    QueryModifier
  73. def removeQueryParams(keys: Iterable[String]): Request

    Removes the specified keys from the query parameters.

    Removes the specified keys from the query parameters.

    Definition Classes
    QueryModifier
  74. final def setHeaders(headers: Headers): Request
    Definition Classes
    HeaderModifier
  75. def setQueryParams(queryParams: (String, Chunk[String])*): Request
    Definition Classes
    QueryModifier
  76. def setQueryParams(queryParams: Map[String, Chunk[String]]): Request
    Definition Classes
    QueryModifier
  77. def setQueryParams(values: String): Request
    Definition Classes
    QueryModifier
  78. def setQueryParams(values: QueryParams): Request
    Definition Classes
    QueryModifier
  79. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  80. def unnest(prefix: Path): Request

    Unnests the request by the specified prefix.

    Unnests the request by the specified prefix. If the request URL is not nested at the specified path, then this has no effect on the URL.

  81. def updateBody(f: (Body) => Body): Request

    Returns a request with a body derived from the current body.

  82. def updateBodyZIO[R, E](f: (Body) => ZIO[R, E, Body]): ZIO[R, E, Request]

    Returns a request with a body derived from the current body in an effectful way.

  83. def updateHeaders(update: (Headers) => Headers)(implicit trace: Trace): Request

    Updates the headers using the provided function

    Updates the headers using the provided function

    Definition Classes
    Request → HeaderModifier
  84. def updatePath(f: (Path) => Path): Request
  85. def updateQueryParams(f: (QueryParams) => QueryParams): Request
    Definition Classes
    Request → QueryModifier
  86. def updateURL(f: (URL) => URL): Request
  87. val url: URL
  88. val version: Version
  89. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  90. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  91. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  92. def withBody(body: Body): Request

    Returns a request with the specified body.

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from QueryOps[Request]

Inherited from QueryChecks[Request]

Inherited from QueryGetters[Request]

Inherited from QueryModifier[Request]

Inherited from HeaderOps[Request]

Inherited from HeaderChecks[Request]

Inherited from HeaderGetters

Inherited from HeaderModifier[Request]

Inherited from AnyRef

Inherited from Any

Ungrouped