Trait

tapir

Tapir

Related Doc: package tapir

Permalink

trait Tapir extends TapirDerivedInputs

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tapir
  2. TapirDerivedInputs
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def auth: TapirAuth.type

    Permalink
  6. def binaryBody[T](implicit codec: CodecForOptional[T, OctetStream, _]): Body[T, OctetStream, _]

    Permalink
  7. def body[T, M <: MediaType](implicit tm: CodecForOptional[T, M, _]): Body[T, M, _]

    Permalink
  8. def clientIp: EndpointInput[Option[String]]

    Permalink
    Definition Classes
    TapirDerivedInputs
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def cookie[T](name: String)(implicit arg0: PlainCodecForOptional[T]): Cookie[T]

    Permalink
  11. def cookies: Header[List[Cookie]]

    Permalink
  12. def emptyOutput: EndpointOutput[Unit]

    Permalink

    An empty output.

    An empty output. Useful if one of oneOf branches should be mapped to the status code only.

  13. val endpoint: Endpoint[Unit, Unit, Unit, Nothing]

    Permalink
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. def extractFromRequest[T](f: (ServerRequest) ⇒ T): ExtractFromRequest[T]

    Permalink

    Extract a value from a server request.

    Extract a value from a server request. This input is only used by server interpreters, it is ignored by documentation interpreters and the provided value is discarded by client interpreters.

  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formBody[T](implicit codec: CodecForOptional[T, XWwwFormUrlencoded, _]): Body[T, XWwwFormUrlencoded, _]

    Permalink
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def header[T](name: String)(implicit arg0: PlainCodecForMany[T]): Header[T]

    Permalink
  22. def headers: Headers

    Permalink
  23. val htmlBodyUtf8: Body[String, TextHtml, String]

    Permalink
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. def jsonBody[T](implicit codec: CodecForOptional[T, Json, _]): Body[T, Json, _]

    Permalink
  26. def multipartBody[T](implicit codec: CodecForOptional[T, MultipartFormData, _]): Body[T, MultipartFormData, _]

    Permalink
  27. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  30. def oneOf[I](firstCase: StatusMapping[_ <: I], otherCases: StatusMapping[_ <: I]*): OneOf[I]

    Permalink

    Maps status codes to outputs.

    Maps status codes to outputs. All outputs must have a common supertype (I). Typically, the supertype is a sealed trait, and the mappings are implementing cases classes.

    Note that exhaustiveness of the mappings is not checked (that all subtypes of I are covered).

  31. def path[T](name: String)(implicit arg0: PlainCodec[T]): PathCapture[T]

    Permalink
  32. def path[T](implicit arg0: PlainCodec[T]): PathCapture[T]

    Permalink
  33. def paths: PathsCapture

    Permalink
  34. def plainBody[T](implicit codec: CodecForOptional[T, TextPlain, _]): Body[T, TextPlain, _]

    Permalink
  35. def query[T](name: String)(implicit arg0: PlainCodecForMany[T]): Query[T]

    Permalink
  36. def queryParams: QueryParams

    Permalink
  37. def schemaFor[T](implicit arg0: SchemaFor[T]): Schema

    Permalink
  38. def setCookie(name: String): Header[SetCookieValue]

    Permalink
  39. def setCookies: Header[List[SetCookie]]

    Permalink
  40. def statusCode(statusCode: StatusCode): FixedStatusCode

    Permalink
  41. def statusCode: StatusCode

    Permalink
  42. def statusDefaultMapping[O](output: EndpointOutput[O])(implicit arg0: ClassTag[O]): StatusMapping[O]

    Permalink
  43. def statusMapping[O](statusCode: StatusCode, output: EndpointOutput[O])(implicit arg0: ClassTag[O]): StatusMapping[O]

    Permalink
  44. def streamBody[S](schema: Schema, mediaType: MediaType): Body[S, mediaType.type]

    Permalink
  45. def stringBody(charset: Charset): Body[String, TextPlain, String]

    Permalink
  46. def stringBody(charset: String): Body[String, TextPlain, String]

    Permalink
  47. def stringBody: Body[String, TextPlain, String]

    Permalink
  48. implicit def stringToPath(s: String): EndpointInput[Unit]

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

    Permalink
    Definition Classes
    AnyRef
  50. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  51. final def wait(): Unit

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

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

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

Inherited from TapirDerivedInputs

Inherited from AnyRef

Inherited from Any

Ungrouped