parameters

Type Members

1. trait Body[T] extends Iterable[BodyParameter[_]] with Retrieval[T, HttpRequest]

   

2. trait BodyParameter[T] extends Parameter[T]

   

3. case class BodySpec[T](description: Option[String], contentType: ContentType, deserialize: (String) ⇒ T, serialize: (T) ⇒ String) extends Product with Serializable

   

   Spec required to marshall a body of a custom type

   Spec required to marshall a body of a custom type

   T

   the type of the parameter

   description

   Description to be used in the documentation

   contentType

   The HTTP content type header value

   deserialize

   function to take the input string from the request and attempt to construct a deserialized instance. Exceptions are automatically caught and translated into the appropriate result, so just concentrate on the Happy-path case

   serialize

   function to take the input type and serialize it to a string to be represented in the request

4. class Form extends AnyRef

   

5. class FormBody extends Body[Form]

   

6. abstract class FormField[T] extends Validatable[T, Form] with BodyParameter[T]

   

7. trait Location extends AnyRef

   

8. trait Mandatory[T, From] extends Retrieval[T, From] with Parameter[T] with Validatable[T, From]

   

9. trait Marker[T] extends AnyRef

   

10. trait Optional[T, From] extends Retrieval[Option[T], From] with Parameter[T] with Validatable[T, From]

    

11. case class ParamBinding[T](parameter: Parameter[T], value: String) extends Product with Serializable

    

12. sealed class ParamType extends AnyRef

    

13. trait Parameter[T] extends AnyRef

    

14. case class ParameterSpec[T](name: String, description: Option[String] = None, paramType: ParamType, deserialize: (String) ⇒ T, serialize: (T) ⇒ String) extends Product with Serializable

    

    Spec required to marshall a parameter of a custom type

    Spec required to marshall a parameter of a custom type

    T

    the type of the parameter

    description

    optional description of the parameter (for use in description endpoints)

    deserialize

    function to take the input string from the request and attempt to construct a deserialized instance of T. Exceptions are automatically caught and translated into the appropriate result, so just concentrate on the Happy-path case

    serialize

    function to take the input type and serialize it to a string to be represented in the request

    returns

    a parameter for retrieving a value of type [T] from the request

15. trait Parameters[P[_], R[_]] extends AnyRef

    

    Prototype functions for creating parameters of various types.

16. abstract class PathParameter[T] extends Parameter[T] with Iterable[PathParameter[_]]

    

17. abstract class RequestParameter[T] extends Parameter[T] with Validatable[T, HttpRequest]

    

18. trait Retrieval[T, From] extends AnyRef

    

19. class UniBody[T] extends Body[T]

    

    Represents a generic body which can be written to and retrieved from a request.

    Represents a generic body which can be written to and retrieved from a request.

    T

    the type of the request when it has been deserialized from the request

20. trait Validatable[T, From] extends AnyRef