EffectRequestOps

Instance Constructors

new EffectRequestOps(self: F[Request[F]])

Type Members

type Self = F[Request.Self]

Definition Classes
EffectMessageSyntax → MessageOps

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
Any
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def addCookie(name: String, content: String)(implicit F: Functor[F]): Self

Add a Cookie header with the provided values
Add a Cookie header with the provided values

Definition Classes
RequestOps
final def addCookie(cookie: RequestCookie)(implicit F: Functor[F]): Self

Add a Cookie header for the provided Cookie
Add a Cookie header for the provided Cookie

Definition Classes
RequestOps
final def as[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): F[T]

Decode the Message to the specified type
Decode the Message to the specified type
If no valid Status has been described, allow Ok
T
type of the result
decoder
EntityDecoder used to decode the Message
returns
the effect which will generate the T

Definition Classes
MessageOps
final def asInstanceOf[T0]: T0

Definition Classes
Any
def attemptAs[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): DecodeResult[F, T]

Decode the Message to the specified type
Decode the Message to the specified type
T
type of the result
decoder
EntityDecoder used to decode the Message
returns
the effect which will generate the DecodeResult[T]

Definition Classes
EffectMessageSyntax → MessageOps
final def decode[A](f: (A) ⇒ F[Response[F]])(implicit F: Monad[F], decoder: EntityDecoder[F, A]): F[Response[F]]

Helper method for decoding Requests
Helper method for decoding Requests
Attempt to decode the Request and, if successful, execute the continuation to get a Response. If decoding fails, an UnprocessableEntity Response is generated.

Definition Classes
RequestOps
final def decodeStrict[A](f: (A) ⇒ F[Response[F]])(implicit F: Monad[F], decoder: EntityDecoder[F, A]): F[Response[F]]

Helper method for decoding Requests
Helper method for decoding Requests
Attempt to decode the Request and, if successful, execute the continuation to get a Response. If decoding fails, an UnprocessableEntity Response is generated. If the decoder does not support the MediaType of the Request, a UnsupportedMediaType Response is generated instead.

Definition Classes
RequestOps
def decodeWith[A](decoder: EntityDecoder[F, A], strict: Boolean)(f: (A) ⇒ F[Response[F]])(implicit F: Monad[F]): F[Response[F]]

Like decode, but with an explicit decoder.
Like decode, but with an explicit decoder.
strict
If strict, will return a Status.UnsupportedMediaType http Response if this message's MediaType is not supported by the provided decoder

Definition Classes
EffectRequestOps → RequestOps
final def filterHeaders(f: (Header) ⇒ Boolean)(implicit F: Functor[F]): Self

Remove headers that satisfy the predicate
Remove headers that satisfy the predicate
f
predicate
returns
a new message object which lacks the specified headers

Definition Classes
MessageOps
def getClass(): Class[_ <: AnyVal]

Definition Classes
AnyVal → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def putHeaders(headers: Header*)(implicit F: Functor[F]): Self

Add the provided headers to the existing headers, replacing those of the same header name The passed headers are assumed to contain no duplicate Singleton headers.
Add the provided headers to the existing headers, replacing those of the same header name The passed headers are assumed to contain no duplicate Singleton headers.

Definition Classes
MessageOps
final def removeHeader(key: HeaderKey)(implicit F: Functor[F]): Self

Definition Classes
MessageOps
final def replaceAllHeaders(headers: Header*)(implicit F: Functor[F]): Self

Replace the existing headers with those provided
Replace the existing headers with those provided

Definition Classes
MessageOps
final def replaceAllHeaders(headers: Headers)(implicit F: Functor[F]): Self

Replaces the Headers of the incoming Request object
Replaces the Headers of the incoming Request object
headers
Headers containing the desired headers
returns
a new Request object

Definition Classes
MessageOps
val self: F[Request[F]]

Definition Classes
EffectRequestOps → EffectMessageSyntax
def toString(): String

Definition Classes
Any
def transformHeaders(f: (Headers) ⇒ Headers)(implicit F: Functor[F]): Self

Definition Classes
EffectMessageSyntax → MessageOps
def withAttribute[A](key: AttributeKey[A], value: A)(implicit F: Functor[F]): Self

Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap
Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap
A
type of the value to store
key
AttributeKey with which to associate the value
value
value associated with the key
returns
a new message object with the key/value pair appended

Definition Classes
EffectMessageSyntax → MessageOps
def withAttribute[V](entry: AttributeEntry[V])(implicit F: Functor[F]): Self

Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap
Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap
V
type of the value to store
entry
AttributeEntry entry to add
returns
a new message object with the key/value pair appended

Definition Classes
MessageOps
final def withContentType(contentType: Content-Type)(implicit F: Functor[F]): Self

Definition Classes
MessageOps
final def withContentTypeOption(contentTypeO: Option[Content-Type])(implicit F: Functor[F]): Self

Definition Classes
MessageOps
def withEntity[T](b: T)(implicit F: Functor[F], w: EntityEncoder[F, T]): Self

Definition Classes
EffectMessageSyntax
def withPathInfo(pi: String)(implicit F: Functor[F]): F[Request[F]]

Definition Classes
EffectRequestOps → RequestOps
final def withTrailerHeaders(trailerHeaders: F[Headers])(implicit F: Functor[F]): Self

Definition Classes
MessageOps
final def withType(t: MediaType)(implicit F: Functor[F]): Self

Added the org.http4s.headers.Content-Type header to the response
Added the org.http4s.headers.Content-Type header to the response

Definition Classes
MessageOps
final def withoutContentType(implicit F: Functor[F]): Self

Definition Classes
MessageOps

Deprecated Value Members

def withBody[T](b: T)(implicit F: Applicative[F], w: EntityEncoder[F, T]): Self

Definition Classes
EffectMessageSyntax
Annotations
@deprecated
Deprecated
(Since version 0.19) Use withEntity

Related Doc: package syntax

final class EffectRequestOps[F[_]] extends AnyVal with EffectMessageSyntax[F, Request[F]] with RequestOps[F]

Instance Constructors

new EffectRequestOps(self: F[Request[F]])

Type Members

type Self = F[Request.Self]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def addCookie(name: String, content: String)(implicit F: Functor[F]): Self

final def addCookie(cookie: RequestCookie)(implicit F: Functor[F]): Self

final def as[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): F[T]

final def asInstanceOf[T0]: T0

def attemptAs[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): DecodeResult[F, T]

final def decode[A](f: (A) ⇒ F[Response[F]])(implicit F: Monad[F], decoder: EntityDecoder[F, A]): F[Response[F]]

final def decodeStrict[A](f: (A) ⇒ F[Response[F]])(implicit F: Monad[F], decoder: EntityDecoder[F, A]): F[Response[F]]

def decodeWith[A](decoder: EntityDecoder[F, A], strict: Boolean)(f: (A) ⇒ F[Response[F]])(implicit F: Monad[F]): F[Response[F]]

final def filterHeaders(f: (Header) ⇒ Boolean)(implicit F: Functor[F]): Self

def getClass(): Class[_ <: AnyVal]

final def isInstanceOf[T0]: Boolean

final def putHeaders(headers: Header*)(implicit F: Functor[F]): Self

final def removeHeader(key: HeaderKey)(implicit F: Functor[F]): Self

final def replaceAllHeaders(headers: Header*)(implicit F: Functor[F]): Self

final def replaceAllHeaders(headers: Headers)(implicit F: Functor[F]): Self

val self: F[Request[F]]

def toString(): String

def transformHeaders(f: (Headers) ⇒ Headers)(implicit F: Functor[F]): Self

def withAttribute[A](key: AttributeKey[A], value: A)(implicit F: Functor[F]): Self

def withAttribute[V](entry: AttributeEntry[V])(implicit F: Functor[F]): Self

final def withContentType(contentType: Content-Type)(implicit F: Functor[F]): Self

final def withContentTypeOption(contentTypeO: Option[Content-Type])(implicit F: Functor[F]): Self

def withEntity[T](b: T)(implicit F: Functor[F], w: EntityEncoder[F, T]): Self

def withPathInfo(pi: String)(implicit F: Functor[F]): F[Request[F]]

final def withTrailerHeaders(trailerHeaders: F[Headers])(implicit F: Functor[F]): Self

final def withType(t: MediaType)(implicit F: Functor[F]): Self

final def withoutContentType(implicit F: Functor[F]): Self

Deprecated Value Members

def withBody[T](b: T)(implicit F: Applicative[F], w: EntityEncoder[F, T]): Self

Inherited from RequestOps[F]

Inherited from EffectMessageSyntax[F, Request[F]]

Inherited from MessageOps[F]

Inherited from AnyVal

Inherited from Any

Ungrouped