Class

com.avsystem.commons.rest

RestDataCompanion

Related Doc: package rest

Permalink

abstract class RestDataCompanion[T] extends HasGenCodec[T] with DefaultRestImplicits

Base class for companion objects of ADTs (case classes, objects, sealed hierarchies) which are used as parameter or result types in REST API traits. Automatically provides instances of GenCodec and RestSchema.

Example: 

  1. case class User(id: String, name: String, birthYear: Int)
object User extends RestDataCompanion[User]
Linear Supertypes
DefaultRestImplicits, GenCodecRestImplicits, FloatingPointRestImplicits, FutureRestImplicits, HasGenCodec[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RestDataCompanion
  2. DefaultRestImplicits
  3. GenCodecRestImplicits
  4. FloatingPointRestImplicits
  5. FutureRestImplicits
  6. HasGenCodec
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RestDataCompanion()(implicit macroRestStructure: MacroGenerated[DefaultRestImplicits, RestStructure[T]], macroCodec: MacroGenerated[Any, GenCodec[T]])

    Permalink

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. implicit def asRawJsonNotFound[T](implicit forGenCodec: ImplicitNotFound[GenCodec[T]]): ImplicitNotFound[AsRaw[JsonValue, T]]

    Permalink
    Definition Classes
    GenCodecRestImplicits
    Annotations
    @implicitNotFound( ... )

  6. implicit def asRealJsonNotFound[T](implicit forGenCodec: ImplicitNotFound[GenCodec[T]]): ImplicitNotFound[AsReal[JsonValue, T]]

    Permalink
    Definition Classes
    GenCodecRestImplicits
    Annotations
    @implicitNotFound( ... )

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. implicit val codec: GenCodec[T]

    Permalink
    Definition Classes
    HasGenCodec

  9. implicit final val doubleHeaderValueAsRealRaw: AsRawReal[HeaderValue, Double]

    Permalink
    Definition Classes
    FloatingPointRestImplicits

  10. implicit final val doublePathValueAsRealRaw: AsRawReal[PathValue, Double]

    Permalink
    Definition Classes
    FloatingPointRestImplicits

  11. implicit final val doubleQueryValueAsRealRaw: AsRawReal[QueryValue, Double]

    Permalink
    Definition Classes
    FloatingPointRestImplicits

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

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. implicit final val floatHeaderValueAsRealRaw: AsRawReal[HeaderValue, Float]

    Permalink
    Definition Classes
    FloatingPointRestImplicits

  16. implicit final val floatPathValueAsRealRaw: AsRawReal[PathValue, Float]

    Permalink
    Definition Classes
    FloatingPointRestImplicits

  17. implicit final val floatQueryValueAsRealRaw: AsRawReal[QueryValue, Float]

    Permalink
    Definition Classes
    FloatingPointRestImplicits

  18. implicit def futureAsRawNotFound[T](implicit forResponse: ImplicitNotFound[AsRaw[RestResponse, T]]): ImplicitNotFound[AsRaw[Async[RestResponse], commons.Try[commons.Future[T]]]]

    Permalink
    Definition Classes
    FutureRestImplicits
    Annotations
    @implicitNotFound( "#{forResponse}" )

  19. implicit def futureAsRealNotFound[T](implicit forResponse: ImplicitNotFound[AsReal[RestResponse, T]]): ImplicitNotFound[AsReal[Async[RestResponse], commons.Try[commons.Future[T]]]]

    Permalink
    Definition Classes
    FutureRestImplicits
    Annotations
    @implicitNotFound( "#{forResponse}" )

  20. implicit def futureFromAsyncResp[T](implicit respAsReal: AsReal[RestResponse, T]): AsReal[Async[RestResponse], commons.Try[commons.Future[T]]]

    Permalink
    Definition Classes
    FutureRestImplicits

  21. implicit def futureHttpResponseType[T]: HttpResponseType[commons.Future[T]]

    Permalink
    Definition Classes
    FutureRestImplicits

  22. implicit def futureRestResultType[T](implicit arg0: RestResponses[T]): RestResultType[commons.Future[T]]

    Permalink
    Definition Classes
    FutureRestImplicits

  23. implicit def futureRestResultTypeNotFound[T](implicit forRestResponses: ImplicitNotFound[RestResponses[T]]): ImplicitNotFound[RestResultType[commons.Future[T]]]

    Permalink
    Definition Classes
    FutureRestImplicits
    Annotations
    @implicitNotFound( "#{forRestResponses}" )

  24. implicit def futureToAsyncResp[T](implicit respAsRaw: AsRaw[RestResponse, T]): AsRaw[Async[RestResponse], commons.Try[commons.Future[T]]]

    Permalink
    Definition Classes
    FutureRestImplicits

  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  26. final def handleReadFailure[T](expr: ⇒ T): T

    Permalink
    Attributes
    protected
    Definition Classes
    GenCodecRestImplicits

  27. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  28. implicit def headerValueDefaultAsRealRaw[T](implicit arg0: GenKeyCodec[T]): Fallback[AsRawReal[HeaderValue, T]]

    Permalink
    Definition Classes
    GenCodecRestImplicits

  29. implicit def httpResponseTypeNotFound[T]: ImplicitNotFound[HttpResponseType[T]]

    Permalink
    Definition Classes
    FutureRestImplicits
    Annotations
    @implicitNotFound( ... )

  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  31. implicit def jsonValueDefaultAsRealRaw[T](implicit arg0: GenCodec[T]): Fallback[AsRawReal[JsonValue, T]]

    Permalink
    Definition Classes
    GenCodecRestImplicits

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

    Permalink
    Definition Classes
    AnyRef

  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  35. implicit def pathValueFallbackAsRealRaw[T](implicit arg0: GenKeyCodec[T]): Fallback[AsRawReal[PathValue, T]]

    Permalink
    Definition Classes
    GenCodecRestImplicits

  36. implicit def queryValueDefaultAsRealRaw[T](implicit arg0: GenKeyCodec[T]): Fallback[AsRawReal[QueryValue, T]]

    Permalink
    Definition Classes
    GenCodecRestImplicits

  37. implicit def rawRestAsRawNotFound[T]: ImplicitNotFound[AsRaw[RawRest, T]]

    Permalink
    Definition Classes
    DefaultRestImplicits
    Annotations
    @implicitNotFound( ... )

  38. implicit def rawRestAsRealNotFound[T]: ImplicitNotFound[AsReal[RawRest, T]]

    Permalink
    Definition Classes
    DefaultRestImplicits
    Annotations
    @implicitNotFound( ... )

  39. implicit lazy val restSchema: RestSchema[T]

    Permalink

  40. implicit lazy val restStructure: RestStructure[T]

    Permalink

  41. implicit def schemaNotFound[T]: ImplicitNotFound[RestSchema[T]]

    Permalink
    Definition Classes
    DefaultRestImplicits
    Annotations
    @implicitNotFound( ... )

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

    Permalink
    Definition Classes
    AnyRef

  43. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  44. final def wait(): Unit

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

  45. final def wait(arg0: Long, arg1: Int): Unit

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

  46. final def wait(arg0: Long): Unit

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

Inherited from DefaultRestImplicits

Inherited from GenCodecRestImplicits

Inherited from FloatingPointRestImplicits

Inherited from FutureRestImplicits

Inherited from HasGenCodec[T]

Inherited from AnyRef

Inherited from Any

Ungrouped