Packages

trait PathBindable[A] extends AnyRef

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

class HomeController @Inject() (val controllerComponents: ControllerComponents) extends BaseController {
  def show(user: User) = Action {
    ...
  }
}

The definition of 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(key, user.id)
    }
  }
}
Self Type
PathBindable[A]
Annotations
@implicitNotFound()
Source
Binders.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Parsing, bindableBoolean, bindableChar, bindableDouble, bindableFloat, bindableInt, bindableLong, bindableString, bindableUUID
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PathBindable
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. 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

  2. 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

  1. def javascriptUnbind: String

    Javascript function to unbind in the Javascript router.

  2. def transform[B](toB: (A) => B, toA: (B) => A): PathBindable[B]

    Transform this PathBinding[A] to PathBinding[B]