parameters

Type Members

1. trait Bindable[-T, +B <: Binding] extends AnyRef

   

   Allows binding of a value to an entity (eg.

   Allows binding of a value to an entity (eg. query/header/field...)

2. sealed trait Binding extends AnyRef

   

   Represents the binding of a parameter to it's value in a particular context

3. trait Body[T] extends Iterable[BodyParameter] with Mandatory[Message, T] with Rebindable[Message, T, RequestBinding]

   

4. trait BodyParameter extends Parameter

   

5. case class BodySpec[T](contentType: ContentType, paramType: ParamType, deserialize: (Buf) ⇒ T, serialize: (T) ⇒ Buf = (s: T) => Buf.Utf8(s.toString)) 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 deserialised body

   contentType

   The HTTP content type header value

   paramType

   How the body is represented when documenting APIs.

   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

6. case class ExtractedRouteRequest(request: Request, contents: Map[Any, Extraction[Any]]) extends RequestProxy with Product with Serializable

   

7. case class Form(fields: Map[String, Seq[String]] = Map.empty, files: Map[String, Seq[MultiPartFile]] = Map.empty, errors: Seq[ExtractionError] = Nil) extends Product with Serializable

   

   The body entity of a encoded HTML form.

   The body entity of a encoded HTML form. Basically a wrapper for Form construction and field extraction.

8. trait FormElementBinding extends (Form) ⇒ Form

   

9. trait FormField[T] extends BodyParameter

   

10. class FormFieldBinding extends RequestBinding with FormElementBinding

    

11. sealed trait FormFieldExtractor extends AnyRef

    

12. class FormFileBinding extends RequestBinding with FormElementBinding

    

13. sealed trait FormValidator extends AnyRef

    

    A strategy for validating the fields in a form

14. trait HeaderParameter[T] extends Parameter with Rebindable[Message, T, RequestBinding]

    

15. case class InMemoryMultiPartFile(filename: String, content: Buf, contentType: Option[String] = None) extends MultiPartFile with Product with Serializable

    

    This is a multipart form file element that is under the max memory limit, and thus has been kept

16. trait LengthValidations[T <: AnyRef { def isEmpty(): Boolean }] extends AnyRef

    

    Reusable validation functions for parameter and body types

17. trait Mandatory[-From, T] extends Retrieval[From, T] with Extractor[From, T]

    

18. trait MandatoryParameter[From, T, Bnd <: Binding] extends Mandatory[From, T] with ExtractableParameter[From, T] with Rebindable[From, T, Bnd]

    

19. abstract class MultiFile extends Parameter with Bindable[Seq[MultiPartFile], FormFileBinding] with FormField[Seq[MultiPartFile]]

    

20. abstract class MultiFormField[T] extends MultiParameter[T, Form, FormFieldBinding] with FormField[Seq[T]]

    

21. abstract class MultiHeaderParameter[T] extends MultiParameter[T, Message, RequestBinding] with HeaderParameter[Seq[T]]

    

22. abstract class MultiParameter[T, From, B <: Binding] extends Parameter with Bindable[Seq[T], B]

    

23. trait MultiParameters[P[_], R[_]] extends AnyRef

    

    Support for parameters which can have more than one value (e.g query parameters or forms)

24. sealed trait MultiPartFile extends AnyRef

    

25. class MultiPartFormBody extends Body[Form]

    

26. abstract class MultiQueryParameter[T] extends MultiParameter[T, Request, QueryBinding] with QueryParameter[Seq[T]]

    

27. case class OnDiskMultiPartFile(filename: String, content: File, contentType: Option[String] = None) extends MultiPartFile with Product with Serializable

    

    This is a multipart form file element that is over the max memory limit, and thus has been stored on disk temporarily

28. trait Optional[-From, T] extends Retrieval[From, Option[T]] with Extractor[From, T]

    

29. trait OptionalParameter[From, T, Bnd <: Binding] extends Optional[From, T] with ExtractableParameter[From, T] with Rebindable[From, T, Bnd]

    

30. sealed class ParamType extends AnyRef

    

    How a parameter is represented in the HTTP message (JSON type)

31. trait Parameter extends AnyRef

    

    A parameter is a name-value pair which can be encoded into an HTTP message.

    A parameter is a name-value pair which can be encoded into an HTTP message. Sub-types represent the various places in which values are encoded (eg. header/form/query/path)

32. trait ParameterExtractAndBind[From, Rep, B <: Binding] extends AnyRef

    

    Parameter location specific utility functions to assist with extraction and binding of values

33. case class ParameterSpec[T](paramType: ParamType, deserialize: (String) ⇒ T, serialize: (T) ⇒ String = (s: T) => s.toString) extends Product with Serializable

    

    Spec required to marshal and unmarshal a parameter of a custom type

    Spec required to marshal and unmarshal a parameter of a custom type

    T

    the type of the deserialised parameter

    paramType

    The parameter type to be used in the documentation. For custom types, this is usually ObjectParamType (for JSON) or StringParamType

    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

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

    

    Prototype functions for creating parameters of various types.

35. trait PathBindable[T] extends Bindable[T, PathBinding]

    

36. class PathBinding extends Binding

    

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

    

38. class QueryBinding extends Binding

    

39. trait QueryParameter[T] extends Parameter with Rebindable[Request, T, QueryBinding]

    

40. trait Rebindable[-From, T, +B <: Binding] extends Bindable[T, B]

    

    Used to transparently copy the value out of an incoming request (or form etc..) and into an outgoing one.

    Used to transparently copy the value out of an incoming request (or form etc..) and into an outgoing one. Useful when chaining requests together.

41. class RequestBinding extends Binding

    

42. trait Retrieval[-From, T] extends AnyRef

    

    Represents the ability to retrieve a value from an enclosing object (request/form etc..)

43. abstract class SingleFile extends Parameter with Bindable[MultiPartFile, FormFileBinding] with FormField[MultiPartFile]

    

44. abstract class SingleParameter[T, From, B <: Binding] extends Parameter with Bindable[T, B]

    

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

    

    Represents a single entity which makes up the entirety of an HTTP message body.

    Represents a single entity which makes up the entirety of an HTTP message body.

    T

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

46. class UrlEncodedFormBody extends Body[Form]

    

47. trait Value[T] extends Any

    

48. class WebFormValidator extends FormValidator

    

    Web-forms are a less harsh version of forms, which report both a collection of received fields and a set of invalid fields.

    Web-forms are a less harsh version of forms, which report both a collection of received fields and a set of invalid fields. This form-type is to be used for web forms (where feedback is desirable and the user can be redirected back to the form page). As such, extracting an invalid webform from a request will not fail unless the body encoding itself is invalid.