DatastarRequest

zio.http.datastar.model.DatastarRequest
See theDatastarRequest companion object
final case class DatastarRequest(method: Method, url: URL, options: DatastarRequestOptions)

Attributes

Companion
object
Source
DatastarRequest.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def baseUrl(url: URL): DatastarRequest

Attributes

Source
DatastarRequest.scala
override def headers: Headers

Returns the headers

Returns the headers

Attributes

Definition Classes
Source
DatastarRequest.scala
override def queryParameters: QueryParams

Attributes

Definition Classes
Source
DatastarRequest.scala
def render: String

Attributes

Source
DatastarRequest.scala
def renderUrl: String

Attributes

Source
DatastarRequest.scala
def stripMargin: Js
Implicitly added by toJsExpr

Attributes

Source
Js.scala
override def updateHeaders(update: Headers => Headers)(implicit trace: Trace): DatastarRequest

Updates the current Headers with new one, using the provided update function passed.

Updates the current Headers with new one, using the provided update function passed.

Attributes

Definition Classes
Source
DatastarRequest.scala
override def updateQueryParams(f: QueryParams => QueryParams): DatastarRequest

Updates the current query parameters with new one, using the provided update function passed.

Updates the current query parameters with new one, using the provided update function passed.

Attributes

Definition Classes
Source
DatastarRequest.scala

Inherited methods

def ++(that: QueryParams): DatastarRequest

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.

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.

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
final def addHeader[T](value: T)(implicit schema: Schema[T]): DatastarRequest

Adds headers based on the given value. The type of the value must have a schema and be a case class and all fields will be added as headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. The header names are the field names.

Adds headers based on the given value. The type of the value must have a schema and be a case class and all fields will be added as headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. The header names are the field names.

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
final def addHeader[T](name: String, value: T)(implicit schema: Schema[T]): DatastarRequest

Adds a header / headers with the specified name and based on the given value. The value type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Adds a header / headers with the specified name and based on the given value. The value type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
protected def addHeader(name: CharSequence, value: CharSequence): DatastarRequest

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
final def addHeader(header: Header): DatastarRequest

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
final def addHeaders(headers: Iterable[(CharSequence, CharSequence)]): DatastarRequest

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
final def addHeaders(headers: Headers): DatastarRequest

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
def addQueryParam[T](value: T)(implicit schema: Schema[T]): DatastarRequest

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParam[T](key: String, value: T)(implicit schema: Schema[T]): DatastarRequest

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParam(key: String): DatastarRequest

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParam(key: String, value: String): DatastarRequest

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

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

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParams(queryParams: Iterable[(String, String)]): DatastarRequest

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParams(values: String): DatastarRequest

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParams(key: String, value: Chunk[String]): DatastarRequest

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

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

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
final def hasContentType(mediaType: MediaType): Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def hasContentType(value: CharSequence): Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def hasFormMultipartContentType: Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def hasFormUrlencodedContentType: Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def hasHeader(header: Header): Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def hasHeader(headerType: HeaderType): Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def hasHeader(name: CharSequence): Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def hasJsonContentType: Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
def hasQueryParam(name: CharSequence): Boolean

Attributes

Inherited from:
QueryChecks
Source
QueryChecks.scala
final def hasTextPlainContentType: Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def hasXhtmlXmlContentType: Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def hasXmlContentType: Boolean

Attributes

Inherited from:
HeaderChecks
Source
HeaderChecks.scala
final def header[T](implicit schema: Schema[T]): Either[HeaderError, T]

Retrieves headers as a value of the specified type. The type must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

Retrieves headers as a value of the specified type. The type must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
final def header[T](name: String)(implicit schema: Schema[T]): Either[HeaderError, T]

Retrieves the header with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Retrieves the header with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
final def header(headerType: HeaderType): Option[headerType.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

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
final def headerOrElse[T](default: => T)(implicit schema: Schema[T]): T

Retrieves headers as a value of the specified type T, or returns a default value if the headers are not present or could not be parsed. The type T must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

Retrieves headers as a value of the specified type T, or returns a default value if the headers are not present or could not be parsed. The type T must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
final def headerOrElse[T](name: String, default: => T)(implicit schema: Schema[T]): T

Retrieves the header with the specified name as a value of the specified type T, or returns a default value if the header is not present or could not be parsed. The type T must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Retrieves the header with the specified name as a value of the specified type T, or returns a default value if the header is not present or could not be parsed. The type T must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
final def headerOrFail(headerType: HeaderType): Option[Either[String, headerType.HeaderValue]]

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

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

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
final def headerZIO[T](name: String)(implicit schema: Schema[T]): IO[HeaderError, T]

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
final def headers(headerType: HeaderType): Chunk[headerType.HeaderValue]

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
def productElementNames: Iterator[String]
Implicitly added by toJsExpr

Attributes

Inherited from:
Product
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]
Implicitly added by toJsExpr

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def query[T](implicit schema: Schema[T]): Either[QueryParamError, T]

Retrieves query parameters as a value of the specified type. The type must have a schema and be a case class and all fields must be query parameters. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Query parameters are selected by field names.

Retrieves query parameters as a value of the specified type. The type must have a schema and be a case class and all fields must be query parameters. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Query parameters are selected by field names.

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
def query[T](key: String)(implicit schema: Schema[T]): Either[QueryParamError, T]

Retrieves the query parameter with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Retrieves the query parameter with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
def queryOrElse[T](default: => T)(implicit schema: Schema[T]): T

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
def queryOrElse[T](key: String, default: => T)(implicit schema: Schema[T]): T

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
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.

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
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.

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
def queryParams(key: String): Chunk[String]

Retrieves all query parameter values having the specified name.

Retrieves all query parameter values having the specified name.

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
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.

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
def queryZIO[T](key: String)(implicit schema: Schema[T]): IO[QueryParamError, 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

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
final def rawHeader(headerType: HeaderType): Option[String]

Gets the raw unparsed header value

Gets the raw unparsed header value

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
final def rawHeader(name: CharSequence): Option[String]

Gets the raw unparsed header value

Gets the raw unparsed header value

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
def rawHeaders(name: CharSequence): Chunk[String]

Attributes

Inherited from:
HeaderGetters
Source
HeaderGetters.scala
final def removeHeader(name: String): DatastarRequest

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
final def removeHeader(headerType: HeaderType): DatastarRequest

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
final def removeHeaders(headers: Set[String]): DatastarRequest

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
def removeQueryParam(key: String): DatastarRequest

Removes the specified key from the query parameters.

Removes the specified key from the query parameters.

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def removeQueryParams(keys: Iterable[String]): DatastarRequest

Removes the specified keys from the query parameters.

Removes the specified keys from the query parameters.

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
final def setHeaders(headers: Headers): DatastarRequest

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
def setQueryParams(queryParams: (String, Chunk[String])*): DatastarRequest

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def setQueryParams(queryParams: Map[String, Chunk[String]]): DatastarRequest

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def setQueryParams(values: String): DatastarRequest

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def setQueryParams(values: QueryParams): DatastarRequest

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def valueCount(name: CharSequence): Int

Attributes

Inherited from:
QueryChecks
Source
QueryChecks.scala

Deprecated and Inherited methods

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.

Attributes

Deprecated
[Since version 3.1.0] Use query(key)[T]
Inherited from:
QueryGetters
Source
QueryGetters.scala
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.

Attributes

Deprecated
[Since version 3.1.0] Use queryParamOrElse(key, default)
Inherited from:
QueryGetters
Source
QueryGetters.scala
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.

Attributes

Deprecated
[Since version 3.1.0] Use queryZIO(key)[T]
Inherited from:
QueryGetters
Source
QueryGetters.scala
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.

Attributes

Deprecated
[Since version 3.1.0] Use query(key)[Chunk[T]
Inherited from:
QueryGetters
Source
QueryGetters.scala
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.

Attributes

Deprecated
[Since version 3.1.0] Use queryParamsOrElse(key, default)
Inherited from:
QueryGetters
Source
QueryGetters.scala
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.

Attributes

Deprecated
[Since version 3.1.0] Use queryZIO(key)[Chunk[T]
Inherited from:
QueryGetters
Source
QueryGetters.scala