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

   Definition Classes

   Any

5.  def auth: TapirAuth.type
6.  def binaryBody[T](implicit codec: CodecForOptional[T, OctetStream, _]): Body[T, OctetStream, _]
7.  def body[T, CF <: CodecFormat](implicit tm: CodecForOptional[T, CF, _]): Body[T, CF, _]
8.  def clientIp: EndpointInput[Option[String]]

   Definition Classes

   TapirDerivedInputs

9.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... ) @native()

10.  def cookie[T](name: String)(implicit arg0: PlainCodecForOptional[T]): Cookie[T]
11.  def cookies: Header[List[Cookie]]
12.  def emptyOutput: EndpointOutput[Unit]

    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]
14.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

15.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

16.  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.

17.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

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

18.  def formBody[T](implicit codec: CodecForOptional[T, XWwwFormUrlencoded, _]): Body[T, XWwwFormUrlencoded, _]
19.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

20.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

21.  def header(name: String, value: String): FixedHeader
22.  def header(h: Header): FixedHeader
23.  def header[T](name: String)(implicit arg0: PlainCodecForMany[T]): Header[T]
24.  def headers: Headers
25.  val htmlBodyUtf8: Body[String, TextHtml, String]
26.  val infallibleEndpoint: Endpoint[Unit, Nothing, Unit, Nothing]
27.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

28.  def jsonBody[T](implicit codec: CodecForOptional[T, Json, _]): Body[T, Json, _]
29.  implicit def mapModifyFunctor[M[KT, TT] <: Map[KT, TT], K, T](implicit cbf: CanBuildFrom[M[K, T], (K, T), M[K, T]]): ModifyMapAtFunctor[M, K, T]

    Definition Classes

    ModifyMacroSupport

30.  def multipartBody[T](implicit codec: CodecForOptional[T, MultipartFormData, _]): Body[T, MultipartFormData, _]
31.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

32.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

33.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

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

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

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

    Definition Classes

    ModifyMacroFunctorSupport

36.  def path[T](name: String)(implicit arg0: PlainCodec[T]): PathCapture[T]
37.  def path[T](implicit arg0: PlainCodec[T]): PathCapture[T]
38.  def paths: PathsCapture
39.  def plainBody[T](implicit codec: CodecForOptional[T, TextPlain, _]): Body[T, TextPlain, _]
40.  def query[T](name: String)(implicit arg0: PlainCodecForMany[T]): Query[T]
41.  def queryParams: QueryParams
42.  def schemaFor[T](implicit arg0: Schema[T]): Schema[T]
43.  def setCookie(name: String): Header[CookieValueWithMeta]
44.  def setCookies: Header[List[CookieWithMeta]]
45.  def statusCode(statusCode: StatusCode): FixedStatusCode
46.  def statusCode: StatusCode
47.  def statusDefaultMapping[O](output: EndpointOutput[O]): StatusMapping[O]

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

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

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

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

    This will fail at compile-time if the type erasure of O is different from O, 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.

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

    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.

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

    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.

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

    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.

52.  def streamBody[S](schema: Schema[_], format: CodecFormat): Body[S, format.type]
    schema

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

    format

    The format of the stream body, which specifies its media type.

53.  def stringBody(charset: Charset): Body[String, TextPlain, String]
54.  def stringBody(charset: String): Body[String, TextPlain, String]
55.  def stringBody: Body[String, TextPlain, String]
56.  implicit def stringToPath(s: String): EndpointInput[Unit]
57.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

58.  def toString(): String

    Definition Classes

    AnyRef → Any

59.  implicit def traversableModifyFunctor[F[_], A](implicit cbf: CanBuildFrom[F[A], A, F[A]], ev: (F[A]) ⇒ TraversableLike[A, F[A]]): ModifyFunctor[F, A]

    Definition Classes

    ModifyMacroSupport

60.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()