Requests

Type Members

abstract type Method

Definition Classes
Methods
abstract type Path[A] <: Url[A]

An URL path carrying an A information
An URL path carrying an A information

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Convenient methods for Paths.
abstract type QueryString[A]

A query string carrying an A information
A query string carrying an A information

Definition Classes
Urls
implicit class QueryStringOps[A] extends AnyRef

Provides convenient methods on QueryString.
abstract type QueryStringParam[A]

A single query string parameter carrying an A information.
A single query string parameter carrying an A information.

Definition Classes
Urls
abstract type Request[A]

Information carried by a whole request (headers and entity)
abstract type RequestEntity[A]

Information carried by request entity
abstract type RequestHeaders[A]

Information carried by requests’ headers
abstract type Segment[A]

An URL path segment carrying an A information.
An URL path segment carrying an A information.

Definition Classes
Urls
abstract type Url[A]

An URL carrying an A information
An URL carrying an A information

Definition Classes
Urls

Abstract Value Members

abstract def Delete: Method

Definition Classes
Methods
abstract def Get: Method

Definition Classes
Methods
abstract def Post: Method

Definition Classes
Methods
abstract def Put: Method

Definition Classes
Methods
abstract def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Chains the two paths
Chains the two paths

Definition Classes
Urls
abstract def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Concatenates two QueryStrings
Concatenates two QueryStrings

Definition Classes
Urls
abstract def emptyHeaders: RequestHeaders[Unit]

No particular information.
No particular information. Does not mean that the headers *have to* be empty. Just that, from a server point of view no information will be extracted from them, and from a client point of view no particular headers will be built in the request.
abstract def emptyRequest: RequestEntity[Unit]

Empty request.
implicit abstract def intQueryString: QueryStringParam[Int]

Ability to define Int query string parameters
Ability to define Int query string parameters

Definition Classes
Urls
implicit abstract def intSegment: Segment[Int]

Ability to define Int path segments
Ability to define Int path segments

Definition Classes
Urls
implicit abstract def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value
Query string parameter containing a Long value

Definition Classes
Urls
implicit abstract def longSegment: Segment[Long]

Segment containing a Long value
Segment containing a Long value

Definition Classes
Urls
abstract def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

Builds a QueryString with one optional parameter of type A.
Builds a QueryString with one optional parameter of type A.
name
Parameter’s name

Definition Classes
Urls
abstract def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

Builds a QueryString with one parameter.
Builds a QueryString with one parameter.
A
Type of the value carried by the parameter
name
Parameter’s name

Definition Classes
Urls
abstract def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

Request for given parameters
Request for given parameters
method
Request method
url
Request URL
abstract def segment[A](name: String)(implicit s: Segment[A]): Path[A]

Builds a path segment carrying an A information
Builds a path segment carrying an A information
name
Name for the segment (for documentation)

Definition Classes
Urls
abstract def staticPathSegment(segment: String): Path[Unit]

Builds a static path segment
Builds a static path segment

Definition Classes
Urls
implicit abstract def stringQueryString: QueryStringParam[String]

Ability to define String query string parameters
Ability to define String query string parameters

Definition Classes
Urls
implicit abstract def stringSegment: Segment[String]

Ability to define String path segments
Ability to define String path segments

Definition Classes
Urls
abstract def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Builds an URL from the given path and query string
Builds an URL from the given path and query string

Definition Classes
Urls

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[A, B](url: Url[A], headers: RequestHeaders[B] = emptyHeaders)(implicit tuplerAC: Tupler[A, B]): Request[Out]

Helper method to perform GET request
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: Path[Unit]

An empty path.
An empty path.
Useful to begin a path definition:
```
path / "foo" / segment[Int]("some-value")
```
Definition Classes
Urls
final def post[A, B, C, AB](url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

Helper method to perform POST request
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait Requests extends Urls with Methods

Type Members

abstract type Method

abstract type Path[A] <: Url[A]

implicit class PathOps[A] extends AnyRef

abstract type QueryString[A]

implicit class QueryStringOps[A] extends AnyRef

abstract type QueryStringParam[A]

abstract type Request[A]

abstract type RequestEntity[A]

abstract type RequestHeaders[A]

abstract type Segment[A]

abstract type Url[A]

Abstract Value Members

abstract def Delete: Method

abstract def Get: Method

abstract def Post: Method

abstract def Put: Method

abstract def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

abstract def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

abstract def emptyHeaders: RequestHeaders[Unit]

abstract def emptyRequest: RequestEntity[Unit]

implicit abstract def intQueryString: QueryStringParam[Int]

implicit abstract def intSegment: Segment[Int]

implicit abstract def longQueryString: QueryStringParam[Long]

implicit abstract def longSegment: Segment[Long]

abstract def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

abstract def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

abstract def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

abstract def segment[A](name: String)(implicit s: Segment[A]): Path[A]

abstract def staticPathSegment(segment: String): Path[Unit]

implicit abstract def stringQueryString: QueryStringParam[String]

implicit abstract def stringSegment: Segment[String]

abstract def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def get[A, B](url: Url[A], headers: RequestHeaders[B] = emptyHeaders)(implicit tuplerAC: Tupler[A, B]): Request[Out]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: Path[Unit]

final def post[A, B, C, AB](url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Methods

Inherited from Urls

Inherited from AnyRef

Inherited from Any

Ungrouped