Scaladoc for scalaz.http.request.Request

Inherited

Hide All
Show all

AnyRef
Any

Visibility

Public
All

Type Members

trait Debug[OUT] extends AnyRef

Value Members

def ![E](p: String, e: ⇒ E): Validation[E, List[Char]]

Returns the first occurrence of the given request parameter in the request URI or the given error value .

Returns the first occurrence of the given request parameter in the request URI or the given error value .
def !(p: String): Option[List[Char]]

Returns the first occurrence of the given request parameter in the request URI .

Returns the first occurrence of the given request parameter in the request URI .
def !![E](p: String, e: ⇒ E): Validation[E, NonEmptyList[List[Char]]]

Returns all occurrences of the given request parameter in the request URI or the given error value .

Returns all occurrences of the given request parameter in the request URI or the given error value .
def !!(p: String): List[List[Char]]

Returns all occurrences of the given request parameter in the request URI .

Returns all occurrences of the given request parameter in the request URI .
def !!||(p: String)(implicit f: Foldable[IN[_][_]]): List[List[Char]]

Returns all occurrences of the given request parameter in the request URI if it exists or in the request body otherwise .

Returns all occurrences of the given request parameter in the request URI if it exists or in the request body otherwise .
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 !?(p: String): Boolean

Returns true if the given request parameter occurs in the request URI .

Returns true if the given request parameter occurs in the request URI .
def !|(p: String)(implicit f: Foldable[IN[_][_]]): Option[List[Char]]

Returns the first occurrence of the given request parameter in the request URI if it exists or in the request body otherwise .

Returns the first occurrence of the given request parameter in the request URI if it exists or in the request body otherwise .
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: RequestHeader): Request[IN[_][_]]

Deletes all headers of the given value from a request .

Deletes all headers of the given value from a request .
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: IN[Byte]): Request[IN[_][_]]

Sets the body of a request .

Sets the body of a request .
def ^!!^: Kleisli[Option[A][A], String, NonEmptyList[List[Char]]]

Returns all occurrences of a given request parameter in the request URI .

Returns all occurrences of a given request parameter in the request URI .
def ^!!||^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, NonEmptyList[List[Char]]]

Returns all occurrences of a given request parameter in the request URI if it exists or in the request body otherwise .

Returns all occurrences of a given request parameter in the request URI if it exists or in the request body otherwise .
def ^!^: Kleisli[Option[A][A], String, List[Char]]

Returns the first occurrence of a given request parameter in the request URI .

Returns the first occurrence of a given request parameter in the request URI .
def ^!|^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, List[Char]]

Returns the first occurrence of a given request parameter in the request URI if it exists or in the request body otherwise .

Returns the first occurrence of a given request parameter in the request URI if it exists or in the request body otherwise .
def ^|!^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, List[Char]]

Returns the first occurrence of a given request parameter in the request body if it exists or in the request URI otherwise .

Returns the first occurrence of a given request parameter in the request body if it exists or in the request URI otherwise .
def ^|^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, List[Char]]

Returns the first occurrence of a given request parameter in the request body .

Returns the first occurrence of a given request parameter in the request body .
def ^||!!^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, NonEmptyList[List[Char]]]

Returns all occurrences of a given request parameter in the request body if it exists or in the request URI otherwise .

Returns all occurrences of a given request parameter in the request body if it exists or in the request URI otherwise .
def ^||^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, NonEmptyList[List[Char]]]

Returns all occurrences of a given request parameter in the request body .

Returns all occurrences of a given request parameter in the request body .
def apply(v: Version): Request[IN[_][_]]

Sets the request version of the status line of a request .

Sets the request version of the status line of a request .
def apply(u: Uri): Request[IN[_][_]]

Sets the request URI of the status line of a request .

Sets the request URI of the status line of a request .
def apply(m: Method): Request[IN[_][_]]

Sets the request method of the status line of a request .

Sets the request method of the status line of a request .
def apply(h: RequestHeader): Option[NonEmptyList[Char]]

Returns the first value that corresponds to the given request header .

Returns the first value that corresponds to the given request header .
def apply(l: Line): Request[IN[_][_]]

Sets the status line of a request .

Sets the status line of a request .
def apply(h: RequestHeader, v: NonEmptyList[Char]): Request[IN[_][_]]

Adds the given request header and value to a request .

Adds the given request header and value to a request .
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: IN[Byte]

§
attributes: abstract

def clone(): AnyRef

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 debug[OUT]: Debug[OUT[_][_]]

Create a response that details the parts of the request in a XHTML document .

def eq(arg0: AnyRef): Boolean

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.

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 .

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 .

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 hashCode(): Int

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[(RequestHeader, NonEmptyList[Char])]

attributes: abstract

Request

trait Request[IN] extends AnyRef

Type Members

trait Debug[OUT] extends AnyRef

Value Members

def ![E](p: String, e: ⇒ E): Validation[E, List[Char]]

def !(p: String): Option[List[Char]]

def !![E](p: String, e: ⇒ E): Validation[E, NonEmptyList[List[Char]]]

def !!(p: String): List[List[Char]]

def !!||(p: String)(implicit f: Foldable[IN[_][_]]): List[List[Char]]

def !=(arg0: AnyRef): Boolean

def !=(arg0: Any): Boolean

def !?(p: String): Boolean

def !|(p: String)(implicit f: Foldable[IN[_][_]]): Option[List[Char]]

def ##(): Int

def $asInstanceOf[T0](): T0

def $isInstanceOf[T0](): Boolean

def -(h: RequestHeader): Request[IN[_][_]]

def ==(arg0: AnyRef): Boolean

def ==(arg0: Any): Boolean

def >>(b: IN[Byte]): Request[IN[_][_]]

def ^!!^: Kleisli[Option[A][A], String, NonEmptyList[List[Char]]]

def ^!!||^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, NonEmptyList[List[Char]]]

def ^!^: Kleisli[Option[A][A], String, List[Char]]

def ^!|^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, List[Char]]

def ^|!^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, List[Char]]

def ^|^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, List[Char]]

def ^||!!^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, NonEmptyList[List[Char]]]

def ^||^(implicit f: Foldable[IN[_][_]]): Kleisli[Option[A][A], String, NonEmptyList[List[Char]]]

def apply(v: Version): Request[IN[_][_]]

def apply(u: Uri): Request[IN[_][_]]

def apply(m: Method): Request[IN[_][_]]

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

def apply(l: Line): Request[IN[_][_]]

def apply(h: RequestHeader, v: NonEmptyList[Char]): Request[IN[_][_]]

def asInstanceOf[T0]: T0

val body: IN[Byte]

def clone(): AnyRef

def debug[OUT]: Debug[OUT[_][_]]

def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

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

def hashCode(): Int

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

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

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

def isDelete: Boolean

def isGet: Boolean

def isHead: Boolean

def isInstanceOf[T0]: Boolean

def isInternetExplorer: Boolean

def isOptions: Boolean

def isPost: Boolean

def isPut: Boolean

def isTrace: Boolean

val line: Line

def method: Method

def ne(arg0: AnyRef): Boolean

def notify(): Unit

def notifyAll(): Unit

def parametersMap: Option[Map[List[Char], NonEmptyList[List[Char]]]]

def parametersMapHeads: Option[Map[List[Char], List[Char]]]

def parts: List[String]

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

def path: NonEmptyList[Char]

def pathEquals(s: String): Boolean

def pathExtension: String

def pathStartsWith(s: String): Boolean

def post(implicit f: Foldable[IN[_][_]]): AnyRef {...}

def queryString(f: (List[Char]) ⇒ Boolean): Boolean

def queryString: Option[List[Char]]

def queryStringEquals(s: String): Boolean

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

def toString(): String

def uri: Uri

def userAgent: Option[NonEmptyList[Char]]

def version: Version

def versionMajor: Digit

def versionMinor: Digit