Router

Instance Constructors

new Router(method: Method, path: PathRule, query: QueryRule, headers: HeaderRule)

method
request methods to match
path
path matching stack
headers
header validation stack

Type Members

type HeaderAppendResult[T <: HList] = Router[T]

Definition Classes
Router → HeaderAppendable

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
def >>>[T2 <: HList](v: TypedHeader[T2])(implicit prep1: Prepend[T2, T]): Router[Out]

Append the header to the builder, generating a new typed representation of the route
Append the header to the builder, generating a new typed representation of the route

Definition Classes
Router → HeaderAppendable
final def ^[R2 >: Nothing](decoder: EntityDecoder[R2])(implicit t: scala.reflect.api.JavaUniverse.TypeTag[R2]): CodecRouter[T, R2]

Alias for decoding
Alias for decoding

Definition Classes
Decodable
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asUri(request: Request): Try[Uri]

Converts a route into an Uri.
Converts a route into an Uri.
If the conversion fails None is returned. In case your route has multiple paths only one way will be resolved as instance of Uri. If the route is a URI Template but not an URI None will be returned.

Definition Classes
UriConvertible
def asUriTemplate(request: Request): Try[UriTemplate]

Converts a route into an UriTemplate.
Converts a route into an UriTemplate.
If the conversion fails None is returned. In case your route has multiple paths only one way will be resolved as instance of UriTemplate.

Definition Classes
TypedBuilder → UriConvertible
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def decoding[R](decoder: EntityDecoder[R])(implicit t: scala.reflect.api.JavaUniverse.TypeTag[R]): CodecRouter[T, R]

Decode the body using the EntityDecoder
Decode the body using the EntityDecoder

Definition Classes
Router → Decodable
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val headers: HeaderRule

header validation stack
header validation stack

Definition Classes
Router → RoutingEntity → TypedBuilder
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def makeAction[F](f: F, hf: HListToFunc[T, F]): RhoAction[T, F]

Create a RhoAction from this RouteExecutable with the provided converters
Create a RhoAction from this RouteExecutable with the provided converters

Definition Classes
Router → RouteExecutable
val method: Method

request methods to match
request methods to match

Definition Classes
Router → RoutingEntity → RouteExecutable
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: PathRule

path matching stack
path matching stack

Definition Classes
Router → RoutingEntity → TypedBuilder
val query: QueryRule

Untyped AST representation of the query to operate on
Untyped AST representation of the query to operate on

Definition Classes
Router → RoutingEntity → TypedBuilder
final def runWith[F, O](f: F)(implicit hf: HListToFunc[T, F]): (Request) ⇒ Task[Option[Response]]

Provide an action from which to generate a complete route
Provide an action from which to generate a complete route
F
the type of f
O
the type of the result generated by f
f
"function" used to in compiling the route
hf
converter used to join the HList generated by the route to the function f
returns
a function Request => Option[Task[Response]] which can be used as a complete route

Definition Classes
RouteExecutable
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def validate[T2 <: HList](header: TypedHeader[T2])(implicit prep: Prepend[T2, T]): HeaderAppendResult[Out]

Definition Classes
HeaderAppendable
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( ... )
final def |>>[F, R](f: F)(implicit hf: HListToFunc[T, F], srvc: CompileService[F, R]): R

Compiles a HTTP request definition into an action
Compiles a HTTP request definition into an action

Definition Classes
RouteExecutable

Related Doc: package rho

case class Router[T <: HList](method: Method, path: PathRule, query: QueryRule, headers: HeaderRule) extends RouteExecutable[T] with HeaderAppendable[T] with RoutingEntity[T] with Decodable[T, Nothing] with Product with Serializable

Instance Constructors

new Router(method: Method, path: PathRule, query: QueryRule, headers: HeaderRule)

Type Members

type HeaderAppendResult[T <: HList] = Router[T]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def >>>[T2 <: HList](v: TypedHeader[T2])(implicit prep1: Prepend[T2, T]): Router[Out]

final def ^[R2 >: Nothing](decoder: EntityDecoder[R2])(implicit t: scala.reflect.api.JavaUniverse.TypeTag[R2]): CodecRouter[T, R2]

final def asInstanceOf[T0]: T0

def asUri(request: Request): Try[Uri]

def asUriTemplate(request: Request): Try[UriTemplate]

def clone(): AnyRef

def decoding[R](decoder: EntityDecoder[R])(implicit t: scala.reflect.api.JavaUniverse.TypeTag[R]): CodecRouter[T, R]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val headers: HeaderRule

final def isInstanceOf[T0]: Boolean

def makeAction[F](f: F, hf: HListToFunc[T, F]): RhoAction[T, F]

val method: Method

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: PathRule

val query: QueryRule

final def runWith[F, O](f: F)(implicit hf: HListToFunc[T, F]): (Request) ⇒ Task[Option[Response]]

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

final def validate[T2 <: HList](header: TypedHeader[T2])(implicit prep: Prepend[T2, T]): HeaderAppendResult[Out]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

final def |>>[F, R](f: F)(implicit hf: HListToFunc[T, F], srvc: CompileService[F, R]): R

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Decodable[T, Nothing]

Inherited from RoutingEntity[T]

Inherited from HeaderAppendable[T]

Inherited from RouteExecutable[T]

Inherited from TypedBuilder[T]

Inherited from UriConvertible

Inherited from AnyRef

Inherited from Any

Ungrouped