PathBindable

Binder for URL path parameters.

You can provide an implementation of PathBindable[A] for any type A you want to be able to bind directly from the request path.

For example, given this class definition:

case class User(id: Int, name: String, age: Int)

You can define a binder retrieving a User instance from its id, useable like the following:

// In your routes:
// GET  /show/:user      controllers.Application.show(user)
// For example: /show/42

object Application extends Controller {
  def show(user: User) = Action {
    ￢ﾀﾦ
  }
}

The definition the binder can look like the following:

object User {
implicit def pathBinder(implicit intBinder: PathBindable[Int]) = new PathBindable[User] {
  override def bind(key: String, value: String): Either[String, User] = {
    for {
      id <- intBinder.bind(key, value).right
      user <- User.findById(id).toRight("User not found").right
    } yield user
  }
  override def unbind(key: String, user: User): String = {
    intBinder.unbind(user.id)
  }
}
}

Self Type: PathBindable[A]
Annotations: @implicitNotFound( ... )
Source: Binders.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

Parsing, bindableBoolean, bindableDouble, bindableFloat, bindableInt, bindableLong, bindableString, bindableUUID

Abstract Value Members

abstract def bind(key: String, value: String): Either[String, A]

Bind an URL path parameter.
Bind an URL path parameter.
key
Parameter key
value
The value as String (extracted from the URL path)
returns
Right of the value or Left of an error message if the binding failed
abstract def unbind(key: String, value: A): String

Unbind a URL path parameter.
Unbind a URL path parameter.
key
Parameter key
value
Parameter value.

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 getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def javascriptUnbind: String

Javascript function to unbind in the Javascript router.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transform[B](toB: (A) ⇒ B, toA: (B) ⇒ A): PathBindable[B]

Transform this PathBinding[A] to PathBinding[B]
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 PathBindable[A] extends AnyRef

Abstract Value Members

abstract def bind(key: String, value: String): Either[String, A]

abstract def unbind(key: String, value: A): String

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 getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def javascriptUnbind: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

def transform[B](toB: (A) ⇒ B, toA: (B) ⇒ A): PathBindable[B]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped