core/org.http4s/Status

Status

sealed abstract case class Status extends Ordered[Status] with Renderable

Representation of the HTTP response code and reason

'''Note: ''' the reason is not important to the protocol and is not considered in equality checks.

Value parameters:
code

HTTP status code

reason

reason for the response. eg, OK

See also:
Companion:
object
trait Serializable
trait Product
trait Equals
trait Ordered[Status]
trait Comparable[Status]
class Object
trait Matchable
class Any

Value members

Concrete methods

def compare(that: Status): Int
def isSuccess: Boolean
override def render(writer: Writer): writer
Definition Classes
def sanitizedReason: String

A sanitized reason phrase. Blank if reason is invalid per RFC7230, otherwise equivalent to reason.

A sanitized reason phrase. Blank if reason is invalid per RFC7230, otherwise equivalent to reason.

def unapply[F[_]](msg: Response[F]): Option[Response[F]]

Helpers for for matching against a Response

Helpers for for matching against a Response

Deprecated methods

@deprecated("Custom status phrases will be removed in 1.0. They are an optional feature, pose a security risk, and already unsupported on some backends.", "0.22.6")
def withReason(reason: String): Status
Deprecated

Inherited methods

def <(that: Status): Boolean
Inherited from:
Ordered
def <=(that: Status): Boolean
Inherited from:
Ordered
def >(that: Status): Boolean
Inherited from:
Ordered
def >=(that: Status): Boolean
Inherited from:
Ordered
def compareTo(that: Status): Int
Inherited from:
Ordered
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def renderString: String

Generates a String rendering of this object

Generates a String rendering of this object

Inherited from:
Renderable
override def toString: String
Definition Classes
Renderable -> Any
Inherited from:
Renderable

Concrete fields

val isEntityAllowed: Boolean
val reason: String