Packages

p

sttp.tapir

ztapir

package ztapir

Linear Supertypes
ZTapir, Tapir, ModifyMacroSupport, ModifyMacroFunctorSupport, TapirDerivedInputs, TapirExtensions, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ztapir
  2. ZTapir
  3. Tapir
  4. ModifyMacroSupport
  5. ModifyMacroFunctorSupport
  6. TapirDerivedInputs
  7. TapirExtensions
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class ModifyEach[F[_], T] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  2. implicit class ModifyEachMap[F[_, _], K, T] extends AnyRef
    Definition Classes
    ModifyMacroSupport
  3. trait ModifyFunctor[F[_], A] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  4. type TapirFile = File
    Definition Classes
    TapirExtensions
  5. final class WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef
    Definition Classes
    Tapir
  6. type ZEndpoint[I, E, O] = Endpoint[I, E, O, Any]
    Definition Classes
    ZTapir
  7. abstract class ZPartialServerEndpoint[R, U, I, E, O] extends EndpointInputsOps[I, E, O, Nothing] with EndpointOutputsOps[I, E, O, Nothing] with EndpointInfoOps[I, E, O, Nothing] with EndpointMetaOps[I, E, O, Nothing]

    An endpoint, with some of the server logic already provided, and some left unspecified.

    An endpoint, with some of the server logic already provided, and some left unspecified. See RichZEndpoint.zServerLogicForCurrent.

    The part of the server logic which is provided transforms some inputs either to an error of type E, or value of type U.

    The part of the server logic which is not provided, transforms a tuple: (U, I) either into an error, or a value of type O.

    Inputs/outputs can be added to partial endpoints as to regular endpoints, however the shape of the error outputs is fixed and cannot be changed.

    R

    The environment needed by the partial server logic.

    U

    Type of partially transformed input.

    I

    Input parameter types.

    E

    Error output parameter types.

    O

    Output parameter types.

  8. type ZServerEndpoint[R, I, E, O] = ServerEndpoint[I, E, O, Any, [β$0$]ZIO[R, Throwable, β$0$]]
    Definition Classes
    ZTapir
  9. abstract class ZServerEndpointInParts[R, U, J, I, E, O] extends EndpointInfoOps[I, E, O, Nothing] with EndpointMetaOps[I, E, O, Nothing]

    An endpoint description together with partial server logic.

    An endpoint description together with partial server logic. See RichZEndpoint.zServerLogicPart.

    The part of the server logic which is provided transforms some inputs either to an error of type E, or value of type U.

    The part of the server logic which is not provided, transforms a tuple: (U, J) either into an error of type E, or a value of type O.

    R

    The environment needed by the partial server logic.

    U

    The type of the value returned by the partial server logic.

    J

    Remaining input parameter types, for which logic has yet to be provided.

    I

    Entire input parameter types. I = T + J, where T is the part of the input consumed by the partial logic, and converted to U.

    E

    Error output parameter types.

    O

    Output parameter types.

  10. trait ZTapir extends AnyRef
  11. implicit class RichZEndpoint[I, E, O] extends AnyRef
    Definition Classes
    ZTapir
  12. implicit class RichZServiceEndpoint[R, I, E, O] extends AnyRef
    Definition Classes
    ZTapir

Value Members

  1. def anyFromStringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF], charset: Charset): Body[String, T]
    Definition Classes
    Tapir
  2. def anyFromUtf8StringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF]): Body[String, T]
    Definition Classes
    Tapir
  3. def anyJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]
    Definition Classes
    Tapir
  4. def auth: TapirAuth.type
    Definition Classes
    Tapir
  5. def binaryBody[R, T](implicit arg0: Binary[R], arg1: Codec[R, T, OctetStream]): Body[R, T]
    Definition Classes
    Tapir
  6. def byteArrayBody: Body[Array[Byte], Array[Byte]]
    Definition Classes
    Tapir
  7. def byteBufferBody: Body[ByteBuffer, ByteBuffer]
    Definition Classes
    Tapir
  8. def clientIp: EndpointInput[Option[String]]
    Definition Classes
    TapirDerivedInputs
  9. def cookie[T](name: String)(implicit arg0: Codec[Option[String], T, TextPlain]): Cookie[T]
    Definition Classes
    Tapir
  10. def cookies: Header[List[Cookie]]
    Definition Classes
    Tapir
  11. val emptyOutput: EndpointOutput[Unit]
    Definition Classes
    Tapir
  12. def emptyOutputAs[T](value: T): EndpointOutput[T]
    Definition Classes
    Tapir
  13. val endpoint: Endpoint[Unit, Unit, Unit, Any]
    Definition Classes
    Tapir
  14. def extractFromRequest[T](f: (ServerRequest) => T): ExtractFromRequest[T]
    Definition Classes
    Tapir
  15. def fileBody: Body[TapirFile, TapirFile]
    Definition Classes
    Tapir
  16. def formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  17. def formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  18. def header(name: String, value: String): FixedHeader[Unit]
    Definition Classes
    Tapir
  19. def header(h: Header): FixedHeader[Unit]
    Definition Classes
    Tapir
  20. def header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
    Definition Classes
    Tapir
  21. def headers: Headers[List[Header]]
    Definition Classes
    Tapir
  22. val htmlBodyUtf8: Body[String, String]
    Definition Classes
    Tapir
  23. val infallibleEndpoint: Endpoint[Unit, Nothing, Unit, Any]
    Definition Classes
    Tapir
  24. def inputStreamBody: Body[InputStream, InputStream]
    Definition Classes
    Tapir
  25. def isWebSocket: EndpointInput[Boolean]
    Definition Classes
    TapirDerivedInputs
  26. def multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
    Definition Classes
    Tapir
  27. val multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
    Definition Classes
    Tapir
  28. def oneOf[T](firstCase: OneOfMapping[_ <: T], otherCases: OneOfMapping[_ <: T]*): OneOf[T, T]
    Definition Classes
    Tapir
  29. def oneOfDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]
    Definition Classes
    Tapir
  30. macro def oneOfMapping[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T]): OneOfMapping[T]
    Definition Classes
    Tapir
  31. def oneOfMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfMapping[T]
    Definition Classes
    Tapir
  32. def oneOfMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfMapping[T]
    Definition Classes
    Tapir
  33. def oneOfMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfMapping[T]
    Definition Classes
    Tapir
  34. def oneOfMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfMapping[T]
    Definition Classes
    Tapir
  35. implicit def optionModifyFunctor[A]: ModifyFunctor[Option, A]
    Definition Classes
    ModifyMacroFunctorSupport
  36. def path[T](name: String)(implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
    Definition Classes
    Tapir
  37. def path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
    Definition Classes
    Tapir
  38. def pathBody: Body[File, Path]
    Definition Classes
    TapirExtensions
  39. def paths: PathsCapture[List[String]]
    Definition Classes
    Tapir
  40. def plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  41. def plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  42. def query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
    Definition Classes
    Tapir
  43. def queryParams: QueryParams[QueryParams]
    Definition Classes
    Tapir
  44. def rawBinaryBody[R](implicit arg0: Binary[R], codec: Codec[R, R, OctetStream]): Body[R, R]
    Definition Classes
    Tapir
  45. def setCookie(name: String): Header[CookieValueWithMeta]
    Definition Classes
    Tapir
  46. def setCookies: Header[List[CookieWithMeta]]
    Definition Classes
    Tapir
  47. def statusCode(statusCode: StatusCode): FixedStatusCode[Unit]
    Definition Classes
    Tapir
  48. def statusCode: StatusCode[StatusCode]
    Definition Classes
    Tapir
  49. def streamBinaryBody[S](s: Streams[S]): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  50. def streamIterableBody[S, C[X] <: Iterable[X], T](s: Streams[S])(schema: Schema[C[T]], emptyIterable: C[T], format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  51. def streamListBody[S, T](s: Streams[S])(schema: Schema[List[T]], format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  52. def streamTextBody[S](s: Streams[S])(format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  53. def stringBody(charset: Charset): Body[String, String]
    Definition Classes
    Tapir
  54. def stringBody(charset: String): Body[String, String]
    Definition Classes
    Tapir
  55. def stringBody: Body[String, String]
    Definition Classes
    Tapir
  56. implicit def stringToPath(s: String): FixedPath[Unit]
    Definition Classes
    Tapir
  57. implicit def traversableModifyFunctor[F[_], A](implicit fac: Factory[A, F[A]], ev: (F[A]) => Iterable[A]): ModifyFunctor[F, A]
    Definition Classes
    ModifyMacroSupport
  58. def webSocketBody[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat]: WebSocketBodyBuilder[REQ, REQ_CF, RESP, RESP_CF]
    Definition Classes
    Tapir
  59. def webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
    Definition Classes
    Tapir
  60. def xmlBody[T](implicit arg0: XmlCodec[T]): Body[String, T]
    Definition Classes
    Tapir

Deprecated Value Members

  1. def statusDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfDefaultMapping

  2. macro def statusMapping[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T]): OneOfMapping[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfMapping

  3. def statusMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfMapping[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfMappingClassMatcher

  4. def statusMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfMapping[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfMappingExactMatcher

  5. def statusMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfMapping[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfMappingFromMatchType

  6. def statusMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfMapping[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfMappingValueMatcher

Inherited from ZTapir

Inherited from Tapir

Inherited from ModifyMacroSupport

Inherited from ModifyMacroFunctorSupport

Inherited from TapirDerivedInputs

Inherited from TapirExtensions

Inherited from AnyRef

Inherited from Any

Ungrouped