t

sttp.tapir

Tapir

trait Tapir extends TapirDerivedInputs with ModifyMacroSupport

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tapir
  2. ModifyMacroSupport
  3. ModifyMacroFunctorSupport
  4. TapirDerivedInputs
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class ModifyEach[F[_], T] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  2. trait ModifyFunctor[F[_], A] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  3. implicit class ModifyEachMap[F[_, _], K, T] extends AnyRef
    Definition Classes
    ModifyMacroSupport
  4. trait ModifyMapAtFunctor[F[_, _], K, T] extends AnyRef
    Definition Classes
    ModifyMacroSupport

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[T](name: String)(implicit arg0: PlainCodecForMany[T]): Header[T]
  23. def headers: Headers
  24. val htmlBodyUtf8: Body[String, TextHtml, String]
  25. val infallibleEndpoint: Endpoint[Unit, Nothing, Unit, Nothing]
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def jsonBody[T](implicit codec: CodecForOptional[T, Json, _]): Body[T, Json, _]
  28. 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
  29. def multipartBody[T](implicit codec: CodecForOptional[T, MultipartFormData, _]): Body[T, MultipartFormData, _]
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. 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).

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

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

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

    Create a mapping to be used in oneOf output descriptions.

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

  49. def stringBody(charset: Charset): Body[String, TextPlain, String]
  50. def stringBody(charset: String): Body[String, TextPlain, String]
  51. def stringBody: Body[String, TextPlain, String]
  52. implicit def stringToPath(s: String): EndpointInput[Unit]
  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. 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
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from ModifyMacroSupport

Inherited from ModifyMacroFunctorSupport

Inherited from TapirDerivedInputs

Inherited from AnyRef

Inherited from Any

Ungrouped