SttpRequest

sttp.tapir.server.stub.SttpRequest
case class SttpRequest(r: RequestT[Identity, _, _], attributes: AttributeMap) extends ServerRequest

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait ServerRequest
trait RequestMetadata
trait HasHeaders
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def attribute[T](k: AttributeKey[T]): Option[T]

Attributes

Definition Classes
ServerRequest
override def attribute[T](k: AttributeKey[T], v: T): SttpRequest

Attributes

Definition Classes
ServerRequest
override def connectionInfo: ConnectionInfo

Attributes

Definition Classes
ServerRequest
override def headers: Seq[Header]

Attributes

Definition Classes
HasHeaders
override def method: Method

Attributes

Definition Classes
RequestMetadata
override def pathSegments: List[String]

Can differ from uri.path, if the endpoint is deployed in a context

Can differ from uri.path, if the endpoint is deployed in a context

Attributes

Definition Classes
ServerRequest
override def protocol: String

Attributes

Definition Classes
ServerRequest
override def queryParameters: QueryParams

Attributes

Definition Classes
ServerRequest
override def underlying: Any

Attributes

Definition Classes
ServerRequest
override def uri: Uri

Attributes

Definition Classes
RequestMetadata
override def withUnderlying(underlying: Any): ServerRequest

Create a copy of this server request, which reads data from the given underlying implementation. The type of underlying should be the same as the type of this.underlying.

Create a copy of this server request, which reads data from the given underlying implementation. The type of underlying should be the same as the type of this.underlying.

Attributes

Definition Classes
ServerRequest

Inherited methods

def contentLength: Option[Long]

Attributes

Inherited from:
HasHeaders
def contentType: Option[String]

Attributes

Inherited from:
HasHeaders
def cookies: Seq[Either[String, CookieWithMeta]]

Attributes

Inherited from:
HasHeaders
def header(h: String): Option[String]

Attributes

Inherited from:
HasHeaders
def headers(h: String): Seq[String]

Attributes

Inherited from:
HasHeaders
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def showShort: String

A short representation of this request, including the request method, path and query.

A short representation of this request, including the request method, path and query.

Attributes

Inherited from:
ServerRequest
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Definition Classes
RequestMetadata -> Any
Inherited from:
RequestMetadata
def unsafeCookies: Seq[CookieWithMeta]

Attributes

Inherited from:
HasHeaders
def withOverride(methodOverride: Option[Method], uriOverride: Option[Uri], protocolOverride: Option[String], connectionInfoOverride: Option[ConnectionInfo], pathSegmentsOverride: Option[List[String]], queryParametersOverride: Option[QueryParams], headersOverride: Option[Seq[Header]]): ServerRequest

Create a copy of this server request, which overrides some of the data that is read from the underlying implementation with the given values. E.g. instead of reading the headers from the underlying request, the headers might be given explicitly.

Create a copy of this server request, which overrides some of the data that is read from the underlying implementation with the given values. E.g. instead of reading the headers from the underlying request, the headers might be given explicitly.

Attributes

Inherited from:
ServerRequest

Inherited fields

lazy val acceptsContentTypes: Either[String, Seq[ContentTypeRange]]

Attributes

Inherited from:
ServerRequest
lazy val contentTypeParsed: Option[MediaType]

Attributes

Inherited from:
ServerRequest