Value Members

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

   Definition Classes

   AnyRef → Any

2.  final def ##: Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  def anyFromStringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF], charset: Charset): Body[String, T]

   A body in any format, read using the given codec, from a raw string read using charset.

5.  def anyFromUtf8StringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF]): Body[String, T]

   A body in any format, read using the given codec, from a raw string read using UTF-8.

6.  def anyJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]

   Json codecs are usually derived from json-library-specific implicits.

   Json codecs are usually derived from json-library-specific implicits. That's why integrations with various json libraries define jsonBody methods, which directly require the library-specific implicits.

   If you have a custom json codec, you should use this method instead.

7.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

8.  def auth: TapirAuth.type
9.  def binaryBody[R, T](implicit arg0: Binary[R], arg1: Codec[R, T, OctetStream]): Body[R, T]
10.  def byteArrayBody: Body[Array[Byte], Array[Byte]]
11.  def byteBufferBody: Body[ByteBuffer, ByteBuffer]
12.  def clientIp: EndpointInput[Option[String]]

    Definition Classes

    TapirDerivedInputs

13.  def clone(): AnyRef

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.CloneNotSupportedException]) @native()

14.  def cookie[T](name: String)(implicit arg0: Codec[Option[String], T, TextPlain]): Cookie[T]
15.  def cookies: Header[List[Cookie]]
16.  val emptyOutput: EndpointOutput[Unit]

    An empty output.

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

17.  val endpoint: Endpoint[Unit, Unit, Unit, Any]
18.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

19.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

20.  def extractFromRequest[T](f: (ServerRequest) => T): ExtractFromRequest[T]

    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.

21.  def fileBody: Body[File, File]
22.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

23.  def formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
24.  def formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
25.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

26.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

27.  def header(name: String, value: String): FixedHeader[Unit]
28.  def header(h: Header): FixedHeader[Unit]
29.  def header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
30.  def headers: Headers[List[Header]]
31.  val htmlBodyUtf8: Body[String, String]
32.  val infallibleEndpoint: Endpoint[Unit, Nothing, Unit, Any]
33.  def inputStreamBody: Body[InputStream, InputStream]
34.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

35.  def isWebSocket: EndpointInput[Boolean]

    Definition Classes

    TapirDerivedInputs

36.  def multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
37.  val multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
38.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

39.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

40.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

41.  def oneOf[T](firstCase: StatusMapping[_ <: T], otherCases: StatusMapping[_ <: T]*): OneOf[T, T]

    Maps status codes to outputs.

    Maps status codes to outputs. All outputs must have a common supertype (T). 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 T are covered).

42.  implicit def optionModifyFunctor[A]: ModifyFunctor[Option, A]

    Definition Classes

    ModifyMacroFunctorSupport

43.  def path[T](name: String)(implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
44.  def path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
45.  def pathBody: Body[File, Path]
46.  def paths: PathsCapture[List[String]]
47.  def plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
48.  def plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
49.  def query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
50.  def queryParams: QueryParams[QueryParams]
51.  def rawBinaryBody[R](implicit arg0: Binary[R], codec: Codec[R, R, OctetStream]): Body[R, R]
52.  def schemaFor[T](implicit arg0: Schema[T]): Schema[T]
53.  def setCookie(name: String): Header[CookieValueWithMeta]
54.  def setCookies: Header[List[CookieWithMeta]]
55.  def statusCode(statusCode: StatusCode): FixedStatusCode[Unit]
56.  def statusCode: StatusCode[StatusCode]
57.  def statusDefaultMapping[T](output: EndpointOutput[T]): StatusMapping[T]

    Create a fallback mapping to be used in oneOf output descriptions.

58.  macro def statusMapping[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T]): StatusMapping[T]

    Create a status mapping which uses statusCode and output if the class of the provided value (when interpreting as a server) matches the runtime class of T.

    Create a status mapping which uses statusCode and output if the class of the provided value (when interpreting as a server) matches the runtime class of T.

    This will fail at compile-time if the type erasure of T is different from T, as a runtime check in this situation would give invalid results. In such cases, use statusMappingClassMatcher, statusMappingValueMatcher or statusMappingFromMatchType instead.

    Should be used in oneOf output descriptions.

59.  def statusMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): StatusMapping[T]

    Create a status mapping which uses statusCode and output if the class of the provided value (when interpreting as a server) matches the given runtimeClass.

    Create a status mapping which uses statusCode and output if the class of the provided value (when interpreting as a server) matches the given runtimeClass. Note that this does not take into account type erasure.

    Should be used in oneOf output descriptions.

60.  def statusMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): StatusMapping[T]

    Create a status mapping which uses statusCode and output if the provided value exactly matches one of the values provided in the second argument list.

    Create a status mapping which uses statusCode and output if the provided value exactly matches one of the values provided in the second argument list.

    Should be used in oneOf output descriptions.

61.  def statusMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): StatusMapping[T]

    Experimental!

    Experimental!

    Create a status mapping which uses statusCode and output if the provided value matches the target type, as checked by MatchType. Instances of MatchType are automatically derived and recursively check that classes of all fields match, to bypass issues caused by type erasure.

    Should be used in oneOf output descriptions.

62.  def statusMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): StatusMapping[T]

    Create a status mapping which uses statusCode and output if the provided value (when interpreting as a server matches the matcher predicate.

    Create a status mapping which uses statusCode and output if the provided value (when interpreting as a server matches the matcher predicate.

    Should be used in oneOf output descriptions.

63.  def streamBody[S](s: Streams[S], schema: Schema[_], format: CodecFormat, charset: Option[Charset] = None): StreamBodyIO[BinaryStream, BinaryStream, S]
    s

    A supported streams implementation.

    schema

    Schema of the body. Note that any schema can be passed here, usually this will be a schema for the "deserialized" stream.

    charset

    An optional charset of the resulting stream's data, to be used in the content type.

64.  def stringBody(charset: Charset): Body[String, String]
65.  def stringBody(charset: String): Body[String, String]
66.  def stringBody: Body[String, String]
67.  implicit def stringToPath(s: String): FixedPath[Unit]
68.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

69.  def toString(): String

    Definition Classes

    AnyRef → Any

70.  implicit def traversableModifyFunctor[F[_], A](implicit fac: Factory[A, F[A]], ev: (F[A]) => Iterable[A]): ModifyFunctor[F, A]

    Definition Classes

    ModifyMacroSupport

71.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

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

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

73.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()

74.  def webSocketBody[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat]: WebSocketBodyBuilder[REQ, REQ_CF, RESP, RESP_CF]
    REQ

    The type of messages that are sent to the server.

    REQ_CF

    The codec format (media type) of messages that are sent to the server.

    RESP

    The type of messages that are received from the server.

    RESP_CF

    The codec format (media type) of messages that are received from the server.

75.  def webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
76.  def xmlBody[T](implicit arg0: XmlCodec[T]): Body[String, T]

    Implement your own xml codec using Codec.xml() before using this method.