Scaladoc for scalaz.http.response.Response

Inherited

Hide All
Show all

AnyRef
Any

Visibility

Public
All

Value Members

def !=(arg0: AnyRef): Boolean

attributes: final
definition classes: AnyRef
def !=(arg0: Any): Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality .
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ##(): Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf[T0](): T0

attributes: final
definition classes: AnyRef
def $isInstanceOf[T0](): Boolean

attributes: final
definition classes: AnyRef
def -(h: ResponseHeader): Response[OUT[_][_]]

Delete the given header value from this response .

Delete the given header value from this response .
def <<[A](a: A)(implicit b: Body[OUT[_][_], A], s: Semigroup[OUT[Byte]]): Response[OUT[_][_]]

Append the given value to the body of this response .

Append the given value to the body of this response .
def <<:[A](a: A)(implicit b: Body[OUT[_][_], A], s: Semigroup[OUT[Byte]]): Response[OUT[_][_]]

Prepend the given value to the body of this response .

Prepend the given value to the body of this response .
def ==(arg0: AnyRef): Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality .
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def ==(arg0: Any): Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality .
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
def >>(b: OUT[Byte]): Response[OUT[_][_]]

Replace the body of this response with the given body .

Replace the body of this response with the given body .
def acceptsXhtml[IN](implicit req: Request[IN[_][_]]): Response[OUT[_][_]]

Sets the content-type response header for XHTML (application/xhtml+xml), however, if the browser identifies itself as not accepting this content type, set the response header for HTML (text/html) .

Sets the content-type response header for XHTML (application/xhtml+xml), however, if the browser identifies itself as not accepting this content type, set the response header for HTML (text/html) .
def apply(h: ResponseHeader): Option[NonEmptyList[Char]]

Return the value of given header .

Return the value of given header .
def apply(l: StatusLine): Response[OUT[_][_]]

Replace the status line of this reponse with the given status line .

Replace the status line of this reponse with the given status line .
def apply(h: ResponseHeader, s: String): Response[OUT[_][_]]

Add the given header and value to this response .

Add the given header and value to this response . This function fails if the given string value is empty.
def apply(h: ResponseHeader, v: NonEmptyList[Char]): Response[OUT[_][_]]

Add the given header and value to this response .

Add the given header and value to this response .
def asInstanceOf[T0]: T0

This method is used to cast the receiver object to be of type T0.

This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
the receiver object .
attributes: final
definition classes: Any
val body: OUT[Byte]

The response body .

The response body .
attributes: abstract
def bodyLength(implicit f: Foldable[OUT[_][_]]): Int

The length of the response body .

The length of the response body .
def bodyString(implicit e: Each[OUT[_][_]]): String

Returns the response body as a string .

Returns the response body as a string .
def clone(): AnyRef

This method creates and returns a copy of the receiver object .

This method creates and returns a copy of the receiver object .
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object .
attributes: protected
definition classes: AnyRef
def contentType(f: (NonEmptyList[Char]) ⇒ Boolean): Boolean

Returns true if the value of the given content-type header satisfies the given condition .

Returns true if the value of the given content-type header satisfies the given condition .
def contentTypeEquals(s: String): Boolean

Returns true if the value of the given content-type header equals the given value .

Returns true if the value of the given content-type header equals the given value .
def eq(arg0: AnyRef): Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
arg0
the object to compare against this object for reference equality .
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals(arg0: Any): Boolean

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).
arg0
the object to compare against this object for equality .
returns
true if the receiver object is equivalent to the argument; false otherwise.
definition classes: AnyRef → Any
def finalize(): Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object .

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object .
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected
definition classes: AnyRef
def getClass(): java.lang.Class[_]

Returns a representation that corresponds to the dynamic class of the receiver object .

Returns a representation that corresponds to the dynamic class of the receiver object .
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object .
attributes: final
definition classes: AnyRef
def hasContentType: Boolean

Returns true if this response has set the content-type header .

Returns true if this response has set the content-type header .
def hashCode(): Int

Returns a hash code value for the object .

Returns a hash code value for the object .
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the object .
definition classes: AnyRef → Any
val headers: List[(ResponseHeader, NonEmptyList[Char])]

The response headers .

The response headers .
attributes: abstract
lazy val headersMap: Map[ResponseHeader, NonEmptyList[NonEmptyList[Char]]]
lazy val headersMapHeads: Map[ResponseHeader, NonEmptyList[Char]]
def html: Response[OUT[_][_]]

Sets the Content-Type response header for HTML .

Sets the Content-Type response header for HTML .
def isBadRequest: Boolean

Returns true if the status code of this response is a 400 Bad Request .

Returns true if the status code of this response is a 400 Bad Request .
def isInstanceOf[T0]: Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def isOK: Boolean

Returns true if the status code of this response is a 200 OK .

Returns true if the status code of this response is a 200 OK .
val line: StatusLine

The response status line .

The response status line .
attributes: abstract
def ne(arg0: AnyRef): Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality .
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
def notify(): Unit

Wakes up a single thread that is waiting on the receiver object's monitor .

Wakes up a single thread that is waiting on the receiver object's monitor .
attributes: final
definition classes: AnyRef
def notifyAll(): Unit

Wakes up all threads that are waiting on the receiver object's monitor .

Wakes up all threads that are waiting on the receiver object's monitor .
attributes: final
definition classes: AnyRef
def reasonPhrase: List[Char]

The response status .

The response status .
def status: Status

The response status .

The response status .
def synchronized[T0](arg0: T0): T0

attributes: final
definition classes: AnyRef
def toString(): String

Returns a string representation of the object .

Returns a string representation of the object .
The default representation is platform dependent.
returns
a string representation of the object .
definition classes: AnyRef → Any
def unary_~[IN](implicit request: Request[IN[_][_]]): Response[OUT[_][_]]

Sets the ContentType response header according to the
Sets the ContentType response header according to the W3C MIME Reference if the given request path has a file extension and corresponds to a known file extension.

def versionMajor: Digit

The response version major of the status line .

def versionMinor: Digit

The response version minor of the status line .

def wait(): Unit

attributes: final

definition classes: AnyRef

def wait(arg0: Long, arg1: Int): Unit

attributes: final

definition classes: AnyRef

def wait(arg0: Long): Unit

attributes: final

definition classes: AnyRef

def xhtml: Response[OUT[_][_]]

Sets the Content-Type response header for XHTML .

def xml: Response[OUT[_][_]]

Sets the Content-Type response header for XML .

def |+|(b: OUT[Byte])(implicit s: Semigroup[OUT[Byte]]): Response[OUT[_][_]]

Append the given value to the body of this response .

Response

trait Response[OUT] extends AnyRef

Value Members

def !=(arg0: AnyRef): Boolean

def !=(arg0: Any): Boolean

def ##(): Int

def $asInstanceOf[T0](): T0

def $isInstanceOf[T0](): Boolean

def -(h: ResponseHeader): Response[OUT[_][_]]

def <<[A](a: A)(implicit b: Body[OUT[_][_], A], s: Semigroup[OUT[Byte]]): Response[OUT[_][_]]

def <<:[A](a: A)(implicit b: Body[OUT[_][_], A], s: Semigroup[OUT[Byte]]): Response[OUT[_][_]]

def ==(arg0: AnyRef): Boolean

def ==(arg0: Any): Boolean

def >>(b: OUT[Byte]): Response[OUT[_][_]]

def acceptsXhtml[IN](implicit req: Request[IN[_][_]]): Response[OUT[_][_]]

def apply(h: ResponseHeader): Option[NonEmptyList[Char]]

def apply(l: StatusLine): Response[OUT[_][_]]

def apply(h: ResponseHeader, s: String): Response[OUT[_][_]]

def apply(h: ResponseHeader, v: NonEmptyList[Char]): Response[OUT[_][_]]

def asInstanceOf[T0]: T0

val body: OUT[Byte]

def bodyLength(implicit f: Foldable[OUT[_][_]]): Int

def bodyString(implicit e: Each[OUT[_][_]]): String

def clone(): AnyRef

def contentType(f: (NonEmptyList[Char]) ⇒ Boolean): Boolean

def contentTypeEquals(s: String): Boolean

def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def getClass(): java.lang.Class[_]

def hasContentType: Boolean

def hashCode(): Int

val headers: List[(ResponseHeader, NonEmptyList[Char])]

lazy val headersMap: Map[ResponseHeader, NonEmptyList[NonEmptyList[Char]]]

lazy val headersMapHeads: Map[ResponseHeader, NonEmptyList[Char]]

def html: Response[OUT[_][_]]

def isBadRequest: Boolean

def isInstanceOf[T0]: Boolean

def isOK: Boolean

val line: StatusLine

def ne(arg0: AnyRef): Boolean

def notify(): Unit

def notifyAll(): Unit

def reasonPhrase: List[Char]

def status: Status

def synchronized[T0](arg0: T0): T0

def toString(): String

def unary_~[IN](implicit request: Request[IN[_][_]]): Response[OUT[_][_]]

def versionMajor: Digit

def versionMinor: Digit

def wait(): Unit

def wait(arg0: Long, arg1: Int): Unit

def wait(arg0: Long): Unit

def xhtml: Response[OUT[_][_]]

def xml: Response[OUT[_][_]]

def |+|(b: OUT[Byte])(implicit s: Semigroup[OUT[Byte]]): Response[OUT[_][_]]