Trait

org.http4s

RequestOps

Related Doc: package http4s

Permalink

trait RequestOps extends MessageOps

Source
MessageOps.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestOps
  2. MessageOps
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Self

    Permalink
    Definition Classes
    MessageOps

Abstract Value Members

  1. abstract def attemptAs[T](implicit decoder: EntityDecoder[T]): DecodeResult[T]

    Permalink

    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 Task which will generate the DecodeResult[T]

    Definition Classes
    MessageOps
  2. abstract def decodeWith[A](decoder: EntityDecoder[A], strict: Boolean)(f: (A) ⇒ Task[Response]): Task[Response]

    Permalink

    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

  3. abstract def getClass(): Class[_]

    Permalink
    Definition Classes
    Any
  4. abstract def transformHeaders(f: (Headers) ⇒ Headers): Self

    Permalink
    Definition Classes
    MessageOps
  5. abstract def withAttribute[A](key: AttributeKey[A], value: A): Self

    Permalink

    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
    MessageOps
  6. abstract def withPathInfo(pi: String): Self

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from RequestOps to any2stringadd[RequestOps] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RequestOps, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from RequestOps to ArrowAssoc[RequestOps] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  6. final def addCookie(name: String, content: String, expires: Option[Instant] = None): Self

    Permalink

    Add a Cookie header with the provided values

  7. final def addCookie(cookie: Cookie): Self

    Permalink

    Add a Cookie header for the provided Cookie

  8. final def as[T](implicit decoder: EntityDecoder[T]): Task[T]

    Permalink

    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 Task which will generate the T

    Definition Classes
    MessageOps
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. final def decode[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

    Permalink

    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.

  11. final def decodeStrict[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

    Permalink

    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.

  12. def ensuring(cond: (RequestOps) ⇒ Boolean, msg: ⇒ Any): RequestOps

    Permalink
    Implicit information
    This member is added by an implicit conversion from RequestOps to Ensuring[RequestOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (RequestOps) ⇒ Boolean): RequestOps

    Permalink
    Implicit information
    This member is added by an implicit conversion from RequestOps to Ensuring[RequestOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): RequestOps

    Permalink
    Implicit information
    This member is added by an implicit conversion from RequestOps to Ensuring[RequestOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): RequestOps

    Permalink
    Implicit information
    This member is added by an implicit conversion from RequestOps to Ensuring[RequestOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  17. final def filterHeaders(f: (Header) ⇒ Boolean): Self

    Permalink

    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
  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from RequestOps to StringFormat[RequestOps] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. def hashCode(): Int

    Permalink
    Definition Classes
    Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. final def putHeaders(headers: Header*): Self

    Permalink

    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
  22. final def removeHeader(key: HeaderKey): Self

    Permalink
    Definition Classes
    MessageOps
  23. final def replaceAllHeaders(headers: Header*): Self

    Permalink

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  24. final def replaceAllHeaders(headers: Headers): Self

    Permalink

    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
  25. def toString(): String

    Permalink
    Definition Classes
    Any
  26. def withAttribute[V](entry: AttributeEntry[V]): Self

    Permalink

    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
  27. final def withContentType(contentType: Option[Content-Type]): Self

    Permalink
    Definition Classes
    MessageOps
  28. final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

    Permalink
    Definition Classes
    MessageOps
  29. final def withType(t: MediaType): Self

    Permalink

    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
  30. def [B](y: B): (RequestOps, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from RequestOps to ArrowAssoc[RequestOps] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from MessageOps

Inherited from Any

Inherited by implicit conversion any2stringadd from RequestOps to any2stringadd[RequestOps]

Inherited by implicit conversion StringFormat from RequestOps to StringFormat[RequestOps]

Inherited by implicit conversion Ensuring from RequestOps to Ensuring[RequestOps]

Inherited by implicit conversion ArrowAssoc from RequestOps to ArrowAssoc[RequestOps]

Ungrouped