io.fintrospect

parameters

package parameters

Visibility
  1. Public
  2. All

Type Members

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

    Allows binding of a value to an entity (eg.

  2. sealed trait Binding extends AnyRef

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

  3. abstract class Body[T] extends Iterable[BodyParameter] with Retrieval[T, Request]

  4. trait BodyParameter extends Parameter

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

  6. case class Form(fields: Map[String, Set[String]]) extends Iterable[(String, Set[String])] with Product with Serializable

    The body entity of a encoded HTML form.

  7. class FormBody extends Body[Form] with Bindable[Form, Binding] with MandatoryRebind[Form, Request, Binding]

  8. abstract class FormField[T] extends BodyParameter with Validatable[T, Form] with Bindable[T, FormFieldBinding]

  9. class FormFieldBinding extends Binding

  10. abstract class HeaderParameter[T] extends Parameter with Validatable[T, Request] with Bindable[T, RequestBinding]

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

  12. trait MandatoryRebind[T, From, B <: Binding] extends Rebindable[T, From, B]

  13. abstract class MultiFormField[T] extends FormField[Seq[T]]

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

    Support for parameters which can have more than one value (e.

  15. abstract class MultiQueryParameter[T] extends QueryParameter[Seq[T]]

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

  17. trait OptionalRebind[T, From, B <: Binding] extends Rebindable[T, From, B]

  18. sealed class ParamType extends AnyRef

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

  19. trait Parameter extends AnyRef

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

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

    Spec required to marshall and demarshall a parameter of a custom type

  21. trait ParameterSpecSupplier[T] extends AnyRef

    By implementing ParameterSpecSupplier[T], we can declare parameters using a shorthand: eg.

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

    Prototype functions for creating parameters of various types.

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

  24. class PathBinding extends Binding

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

  26. class QueryBinding extends Binding

  27. abstract class QueryParameter[T] extends Parameter with Validatable[T, Request] with Bindable[T, QueryBinding]

  28. trait Rebindable[T, From, B <: Binding] extends AnyRef

    Used to transparently copy the value out of an incoming request (or form etc.

  29. class RequestBinding extends Binding

  30. case class RequestBuild(uriParts: Seq[String] = immutable.this.Nil, queries: Map[String, Seq[String]] = ..., fn: (Request) ⇒ Request = ...) extends Product with Serializable

  31. trait Retrieval[T, From] extends AnyRef

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

  32. abstract class SingleFormField[T] extends FormField[T]

  33. abstract class SingleQueryParameter[T] extends QueryParameter[T]

  34. class UniBody[T] extends Body[T] with Bindable[T, RequestBinding] with MandatoryRebind[T, Request, RequestBinding]

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

  35. trait Validatable[T, From] extends AnyRef

    Provides validation about the presence of a value parameter/entity value in a particular context

Value Members

  1. object ArrayParamType extends ParamType

  2. object Body

    Factory methods for various supported HTTP body types.

  3. object BodySpec extends Serializable

  4. object BooleanParamType extends ParamType

  5. object Form extends Serializable

  6. object FormBody

  7. object FormField

  8. object Header

    Parameters which are bound to request headers

  9. object IntegerParamType extends ParamType

  10. object NullParamType extends ParamType

  11. object NumberParamType extends ParamType

  12. object ObjectParamType extends ParamType

  13. object ParameterSpec extends Serializable

    Predefined ParameterSpec instances for common types

  14. object Path extends Parameters[PathParameter, PathBindable]

    Parameters which are bound to the path segments of a URL

  15. object Query

    Parameters which are bound to the query part of a URL

  16. object StringParamType extends ParamType

Ungrouped