Class/Object

io.fintrospect.parameters

BodySpec

Related Docs: object BodySpec | package parameters

Permalink

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

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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BodySpec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BodySpec(contentType: ContentType, paramType: ParamType, deserialize: (Buf) ⇒ T, serialize: (T) ⇒ Buf = (s: T) => Buf.Utf8(s.toString))

    Permalink

    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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def as[ValueType <: Value[T]](implicit mf: Manifest[ValueType]): BodySpec[ValueType]

    Permalink

    Convenience method to avoid boilerplate using map() with a AnyVal case-classes (which can be tagged with Value[T])

    Convenience method to avoid boilerplate using map() with a AnyVal case-classes (which can be tagged with Value[T])

    ValueType

    - the value type of the case class AnyVal

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val contentType: ContentType

    Permalink

    The HTTP content type header value

  8. val deserialize: (Buf) ⇒ T

    Permalink

    function to take the input string from the request and attempt to construct a deserialized instance.

    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

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  13. def map[O](in: (T) ⇒ O): BodySpec[O]

    Permalink

    Uni-directional map functions for this BodySpec type.

    Uni-directional map functions for this BodySpec type. Use this to implement custom Body types

  14. def map[O](in: (T) ⇒ O, out: (O) ⇒ T): BodySpec[O]

    Permalink

    Bi-directional map functions for this ParameterSpec type.

    Bi-directional map functions for this ParameterSpec type. Use this to implement custom Parameter types

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. val paramType: ParamType

    Permalink

    How the body is represented when documenting APIs.

  19. val serialize: (T) ⇒ Buf

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped