Request

trait Request
Companion:
object
class Object
trait Matchable
class Any

Value members

Abstract methods

Decodes the body as a HttpData

Decodes the body as a HttpData

Gets all the headers in the Request

Gets all the headers in the Request

Gets the request's method

Gets the request's method

def url: URL

Gets the complete url

Gets the complete url

Gets the request's http protocol version

Gets the request's http protocol version

Concrete methods

def copy(version: Version, method: Method, url: URL, headers: Headers): Request

Checks is the request is a pre-flight request or not

Checks is the request is a pre-flight request or not

def path: Path

Gets the request's path

Gets the request's path

final def setMethod(method: Method): Request

Overwrites the method in the request

Overwrites the method in the request

final def setPath(path: Path): Request

Overwrites the path in the request

Overwrites the path in the request

final def setUrl(url: URL): Request

Overwrites the url in the request

Overwrites the url in the request

final override def toString: String

Returns a string representation of the request, useful for debugging, logging or other purposes. It contains the essential properties of HTTP request: protocol version, method, URL, headers and remote address.

Returns a string representation of the request, useful for debugging, logging or other purposes. It contains the essential properties of HTTP request: protocol version, method, URL, headers and remote address.

Definition Classes
Any
final override def updateHeaders(update: Headers => Headers): Request

Updates the headers using the provided function

Updates the headers using the provided function

Definition Classes

Inherited methods

final def accept: Option[CharSequence]
Inherited from:
HeaderGetters
final def acceptCharset: Option[CharSequence]
Inherited from:
HeaderGetters
final def acceptEncoding: Option[CharSequence]
Inherited from:
HeaderGetters
final def acceptLanguage: Option[CharSequence]
Inherited from:
HeaderGetters
final def acceptPatch: Option[CharSequence]
Inherited from:
HeaderGetters
final def acceptRanges: Option[CharSequence]
Inherited from:
HeaderGetters
final def accessControlAllowHeaders: Option[CharSequence]
Inherited from:
HeaderGetters
final def accessControlAllowMethods: Option[CharSequence]
Inherited from:
HeaderGetters
final def accessControlAllowOrigin: Option[CharSequence]
Inherited from:
HeaderGetters
final def accessControlExposeHeaders: Option[CharSequence]
Inherited from:
HeaderGetters
final def accessControlMaxAge: Option[CharSequence]
Inherited from:
HeaderGetters
final def accessControlRequestHeaders: Option[CharSequence]
Inherited from:
HeaderGetters
final def accessControlRequestMethod: Option[CharSequence]
Inherited from:
HeaderGetters
final def addHeader(name: CharSequence, value: CharSequence): Request
Inherited from:
HeaderModifier
final def addHeader(header: Header): Request
Inherited from:
HeaderModifier
final def addHeaders(headers: Headers): Request
Inherited from:
HeaderModifier
final def age: Option[CharSequence]
Inherited from:
HeaderGetters
final def allow: Option[CharSequence]
Inherited from:
HeaderGetters
final def authorization: Option[CharSequence]
Inherited from:
HeaderGetters
Inherited from:
HeaderGetters
final def body: Task[Chunk[Byte]]

Decodes the content of request as a Chunk of Bytes

Decodes the content of request as a Chunk of Bytes

Inherited from:
HttpDataExtension
final def bodyAsByteArray: Task[Array[Byte]]
Inherited from:
HttpDataExtension
final def bodyAsCharSequence: ZIO[Any, Throwable, CharSequence]

Decodes the content of request as CharSequence

Decodes the content of request as CharSequence

Inherited from:
HttpDataExtension
final def bodyAsStream: ZStream[Any, Throwable, Byte]

Decodes the content of request as stream of bytes

Decodes the content of request as stream of bytes

Inherited from:
HttpDataExtension
final def bodyAsString: Task[String]

Decodes the content of request as string

Decodes the content of request as string

Inherited from:
HttpDataExtension
final def cacheControl: Option[CharSequence]
Inherited from:
HeaderGetters
final def charset: Charset
Inherited from:
HeaderGetters
final def connection: Option[CharSequence]
Inherited from:
HeaderGetters
final def contentBase: Option[CharSequence]
Inherited from:
HeaderGetters
final def contentDisposition: Option[CharSequence]
Inherited from:
HeaderGetters
final def contentEncoding: Option[CharSequence]
Inherited from:
HeaderGetters
final def contentLanguage: Option[CharSequence]
Inherited from:
HeaderGetters
Inherited from:
HeaderGetters
final def contentLocation: Option[CharSequence]
Inherited from:
HeaderGetters
final def contentMd5: Option[CharSequence]
Inherited from:
HeaderGetters
final def contentRange: Option[CharSequence]
Inherited from:
HeaderGetters
final def contentSecurityPolicy: Option[CharSequence]
Inherited from:
HeaderGetters
final def contentTransferEncoding: Option[CharSequence]
Inherited from:
HeaderGetters
final def contentType: Option[CharSequence]
Inherited from:
HeaderGetters
final def cookieValue(name: CharSequence): Option[CharSequence]
Inherited from:
HeaderGetters
Inherited from:
HeaderGetters
final def date: Option[CharSequence]
Inherited from:
HeaderGetters
final def dnt: Option[CharSequence]
Inherited from:
HeaderGetters
final def etag: Option[CharSequence]
Inherited from:
HeaderGetters
final def expect: Option[CharSequence]
Inherited from:
HeaderGetters
final def expires: Option[CharSequence]
Inherited from:
HeaderGetters
final def from: Option[CharSequence]
Inherited from:
HeaderGetters
final def hasContentType(value: CharSequence): Boolean
Inherited from:
HeaderChecks
final def hasHeader(name: CharSequence): Boolean
Inherited from:
HeaderChecks
final def hasHeader(name: CharSequence, value: CharSequence): Boolean
Inherited from:
HeaderChecks
Inherited from:
HeaderChecks
Inherited from:
HeaderChecks
final def header(headerName: CharSequence): Option[Header]
Inherited from:
HeaderGetters
final def headerValue(headerName: CharSequence): Option[String]
Inherited from:
HeaderGetters
final def headerValues(headerName: CharSequence): List[String]
Inherited from:
HeaderGetters
Inherited from:
HeaderGetters
final def host: Option[CharSequence]
Inherited from:
HeaderGetters
final def ifMatch: Option[CharSequence]
Inherited from:
HeaderGetters
final def ifModifiedSince: Option[CharSequence]
Inherited from:
HeaderGetters
Inherited from:
HeaderGetters
final def ifNoneMatch: Option[CharSequence]
Inherited from:
HeaderGetters
final def ifRange: Option[CharSequence]
Inherited from:
HeaderGetters
final def ifUnmodifiedSince: Option[CharSequence]
Inherited from:
HeaderGetters
final def lastModified: Option[CharSequence]
Inherited from:
HeaderGetters
final def location: Option[CharSequence]
Inherited from:
HeaderGetters
final def maxForwards: Option[CharSequence]
Inherited from:
HeaderGetters
Inherited from:
HeaderGetters
final def origin: Option[CharSequence]
Inherited from:
HeaderGetters
final def pragma: Option[CharSequence]
Inherited from:
HeaderGetters
final def proxyAuthenticate: Option[CharSequence]
Inherited from:
HeaderGetters
final def proxyAuthorization: Option[CharSequence]
Inherited from:
HeaderGetters
final def range: Option[CharSequence]
Inherited from:
HeaderGetters
final def referer: Option[CharSequence]
Inherited from:
HeaderGetters
final def removeHeader(name: String): Request
Inherited from:
HeaderModifier
final def removeHeaders(headers: List[String]): Request
Inherited from:
HeaderModifier
final def retryAfter: Option[CharSequence]
Inherited from:
HeaderGetters
final def secWebSocketAccept: Option[CharSequence]
Inherited from:
HeaderGetters
final def secWebSocketExtensions: Option[CharSequence]
Inherited from:
HeaderGetters
final def secWebSocketKey: Option[CharSequence]
Inherited from:
HeaderGetters
final def secWebSocketLocation: Option[CharSequence]
Inherited from:
HeaderGetters
final def secWebSocketOrigin: Option[CharSequence]
Inherited from:
HeaderGetters
final def secWebSocketProtocol: Option[CharSequence]
Inherited from:
HeaderGetters
final def secWebSocketVersion: Option[CharSequence]
Inherited from:
HeaderGetters
final def server: Option[CharSequence]
Inherited from:
HeaderGetters
final def setCookie: Option[CharSequence]
Inherited from:
HeaderGetters
final def setCookiesDecoded(secret: Option[String]): List[Cookie]
Inherited from:
HeaderGetters
final def setHeaders(headers: Headers): Request
Inherited from:
HeaderModifier
final def te: Option[CharSequence]
Inherited from:
HeaderGetters
final def trailer: Option[CharSequence]
Inherited from:
HeaderGetters
final def transferEncoding: Option[CharSequence]
Inherited from:
HeaderGetters
final def upgrade: Option[CharSequence]
Inherited from:
HeaderGetters
final def upgradeInsecureRequests: Option[CharSequence]
Inherited from:
HeaderGetters
final def userAgent: Option[CharSequence]
Inherited from:
HeaderGetters
final def vary: Option[CharSequence]
Inherited from:
HeaderGetters
final def via: Option[CharSequence]
Inherited from:
HeaderGetters
final def warning: Option[CharSequence]
Inherited from:
HeaderGetters
final def webSocketLocation: Option[CharSequence]
Inherited from:
HeaderGetters
final def webSocketOrigin: Option[CharSequence]
Inherited from:
HeaderGetters
final def webSocketProtocol: Option[CharSequence]
Inherited from:
HeaderGetters
final def withAccept(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAcceptCharset(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAcceptEncoding(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAcceptLanguage(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAcceptPatch(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAcceptRanges(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAccessControlAllowHeaders(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAccessControlAllowOrigin(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAccessControlExposeHeaders(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAccessControlMaxAge(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAccessControlRequestHeaders(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAge(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAllow(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withAuthorization(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withBasicAuthorization(username: String, password: String): Request
Inherited from:
HeaderModifier
final def withCacheControl(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withCacheControlMaxAge(value: Duration): Request
Inherited from:
HeaderModifier
final def withConnection(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentBase(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentDisposition(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentEncoding(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentLanguage(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentLength(value: Long): Request
Inherited from:
HeaderModifier
final def withContentLocation(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentMd5(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentRange(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentSecurityPolicy(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentTransferEncoding(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withContentType(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withCookie(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withDate(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withDnt(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withEtag(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withExpect(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withExpires(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withFrom(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withHost(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withIfMatch(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withIfModifiedSince(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withIfNoneMatch(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withIfRange(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withIfUnmodifiedSince(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withLastModified(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withLocation(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withMaxForwards(value: CharSequence): Request
Inherited from:
HeaderModifier
Inherited from:
HeaderModifier
final def withOrigin(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withPragma(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withProxyAuthenticate(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withProxyAuthorization(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withRange(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withReferer(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withRetryAfter(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withSecWebSocketAccept(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withSecWebSocketExtensions(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withSecWebSocketKey(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withSecWebSocketLocation(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withSecWebSocketOrigin(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withSecWebSocketProtocol(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withSecWebSocketVersion(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withServer(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withSetCookie(value: Cookie): Request
Inherited from:
HeaderModifier
final def withTe(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withTrailer(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withTransferEncoding(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withUpgrade(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withUpgradeInsecureRequests(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withUserAgent(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withVary(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withVia(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withWarning(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withWebSocketLocation(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withWebSocketOrigin(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withWebSocketProtocol(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withWwwAuthenticate(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withXFrameOptions(value: CharSequence): Request
Inherited from:
HeaderModifier
final def withXRequestedWith(value: CharSequence): Request
Inherited from:
HeaderModifier
final def wwwAuthenticate: Option[CharSequence]
Inherited from:
HeaderGetters
final def xFrameOptions: Option[CharSequence]
Inherited from:
HeaderGetters
final def xRequestedWith: Option[CharSequence]
Inherited from:
HeaderGetters