DatastarRequestOptions

zio.http.datastar.model.DatastarRequestOptions
See theDatastarRequestOptions companion object
final case class DatastarRequestOptions(contentType: MediaType = ..., filterSignals: Option[DatastarSignalFilter] = ..., selector: Option[CssSelector] = ..., hdrs: Headers = ..., openWhenHidden: Boolean = ..., retryInterval: Int = ..., retryScaler: Int = ..., retryMaxWaitMs: Int = ..., retryMaxCount: Int = ..., requestCancellation: DatastarRequestCancellation = ..., retry: Option[DatastarRetry] = ..., payload: Option[Js] = ..., cleanup: Option[Js] = ...)

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

override def headers: Headers

Returns the headers

Returns the headers

Attributes

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

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

Inherited methods

final def addHeader[T](value: T)(implicit schema: Schema[T]): DatastarRequestOptions

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]): DatastarRequestOptions

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): DatastarRequestOptions

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.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
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]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
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): DatastarRequestOptions

Attributes

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

Attributes

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

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala
final def setHeaders(headers: Headers): DatastarRequestOptions

Attributes

Inherited from:
HeaderModifier
Source
HeaderModifier.scala