package ztapir
- Alphabetic
- By Inheritance
- ztapir
- ZTapir
- Tapir
- ModifyMacroSupport
- ModifyMacroFunctorSupport
- TapirDerivedInputs
- TapirExtensions
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- implicit class ModifyEach[F[_], T] extends AnyRef
- Definition Classes
- ModifyMacroFunctorSupport
- implicit class ModifyEachMap[F[_, _], K, T] extends AnyRef
- Definition Classes
- ModifyMacroSupport
- trait ModifyFunctor[F[_], A] extends AnyRef
- Definition Classes
- ModifyMacroFunctorSupport
- type TapirFile = File
- Definition Classes
- TapirExtensions
- final class WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef
- Definition Classes
- Tapir
- type ZEndpoint[I, E, O] = Endpoint[I, E, O, Any]
- Definition Classes
- ZTapir
- 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 typeU
.The part of the server logic which is not provided, transforms a tuple:
(U, I)
either into an error, or a value of typeO
.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.
- type ZServerEndpoint[R, I, E, O] = ServerEndpoint[I, E, O, Any, [β$0$]ZIO[R, Throwable, β$0$]]
- Definition Classes
- ZTapir
- 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 typeU
.The part of the server logic which is not provided, transforms a tuple:
(U, J)
either into an error of typeE
, or a value of typeO
.- 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
, whereT
is the part of the input consumed by the partial logic, and converted toU
.- E
Error output parameter types.
- O
Output parameter types.
- trait ZTapir extends AnyRef
- implicit class RichZEndpoint[I, E, O] extends AnyRef
- Definition Classes
- ZTapir
- implicit class RichZServiceEndpoint[R, I, E, O] extends AnyRef
- Definition Classes
- ZTapir
Value Members
- def anyFromStringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF], charset: Charset): Body[String, T]
- Definition Classes
- Tapir
- def anyFromUtf8StringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF]): Body[String, T]
- Definition Classes
- Tapir
- def anyJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]
- Definition Classes
- Tapir
- def auth: TapirAuth.type
- Definition Classes
- Tapir
- def binaryBody[R, T](implicit arg0: Binary[R], arg1: Codec[R, T, OctetStream]): Body[R, T]
- Definition Classes
- Tapir
- def byteArrayBody: Body[Array[Byte], Array[Byte]]
- Definition Classes
- Tapir
- def byteBufferBody: Body[ByteBuffer, ByteBuffer]
- Definition Classes
- Tapir
- def clientIp: EndpointInput[Option[String]]
- Definition Classes
- TapirDerivedInputs
- def cookie[T](name: String)(implicit arg0: Codec[Option[String], T, TextPlain]): Cookie[T]
- Definition Classes
- Tapir
- def cookies: Header[List[Cookie]]
- Definition Classes
- Tapir
- val emptyOutput: EndpointOutput[Unit]
- Definition Classes
- Tapir
- def emptyOutputAs[T](value: T): EndpointOutput[T]
- Definition Classes
- Tapir
- val endpoint: Endpoint[Unit, Unit, Unit, Any]
- Definition Classes
- Tapir
- def extractFromRequest[T](f: (ServerRequest) => T): ExtractFromRequest[T]
- Definition Classes
- Tapir
- def fileBody: Body[TapirFile, TapirFile]
- Definition Classes
- Tapir
- def formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
- Definition Classes
- Tapir
- def formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
- Definition Classes
- Tapir
- def header(name: String, value: String): FixedHeader[Unit]
- Definition Classes
- Tapir
- def header(h: Header): FixedHeader[Unit]
- Definition Classes
- Tapir
- def header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
- Definition Classes
- Tapir
- def headers: Headers[List[Header]]
- Definition Classes
- Tapir
- val htmlBodyUtf8: Body[String, String]
- Definition Classes
- Tapir
- val infallibleEndpoint: Endpoint[Unit, Nothing, Unit, Any]
- Definition Classes
- Tapir
- def inputStreamBody: Body[InputStream, InputStream]
- Definition Classes
- Tapir
- def isWebSocket: EndpointInput[Boolean]
- Definition Classes
- TapirDerivedInputs
- def multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
- Definition Classes
- Tapir
- val multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
- Definition Classes
- Tapir
- def oneOf[T](firstCase: OneOfMapping[_ <: T], otherCases: OneOfMapping[_ <: T]*): OneOf[T, T]
- Definition Classes
- Tapir
- def oneOfDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]
- Definition Classes
- Tapir
- macro def oneOfMapping[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T]): OneOfMapping[T]
- Definition Classes
- Tapir
- def oneOfMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfMapping[T]
- Definition Classes
- Tapir
- def oneOfMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfMapping[T]
- Definition Classes
- Tapir
- def oneOfMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfMapping[T]
- Definition Classes
- Tapir
- def oneOfMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfMapping[T]
- Definition Classes
- Tapir
- implicit def optionModifyFunctor[A]: ModifyFunctor[Option, A]
- Definition Classes
- ModifyMacroFunctorSupport
- def path[T](name: String)(implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
- Definition Classes
- Tapir
- def path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
- Definition Classes
- Tapir
- def pathBody: Body[File, Path]
- Definition Classes
- TapirExtensions
- def paths: PathsCapture[List[String]]
- Definition Classes
- Tapir
- def plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
- Definition Classes
- Tapir
- def plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
- Definition Classes
- Tapir
- def query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
- Definition Classes
- Tapir
- def queryParams: QueryParams[QueryParams]
- Definition Classes
- Tapir
- def rawBinaryBody[R](implicit arg0: Binary[R], codec: Codec[R, R, OctetStream]): Body[R, R]
- Definition Classes
- Tapir
- def setCookie(name: String): Header[CookieValueWithMeta]
- Definition Classes
- Tapir
- def setCookies: Header[List[CookieWithMeta]]
- Definition Classes
- Tapir
- def statusCode(statusCode: StatusCode): FixedStatusCode[Unit]
- Definition Classes
- Tapir
- def statusCode: StatusCode[StatusCode]
- Definition Classes
- Tapir
- def streamBinaryBody[S](s: Streams[S]): StreamBodyIO[BinaryStream, BinaryStream, S]
- Definition Classes
- Tapir
- 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
- def streamListBody[S, T](s: Streams[S])(schema: Schema[List[T]], format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
- Definition Classes
- Tapir
- def streamTextBody[S](s: Streams[S])(format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
- Definition Classes
- Tapir
- def stringBody(charset: Charset): Body[String, String]
- Definition Classes
- Tapir
- def stringBody(charset: String): Body[String, String]
- Definition Classes
- Tapir
- def stringBody: Body[String, String]
- Definition Classes
- Tapir
- implicit def stringToPath(s: String): FixedPath[Unit]
- Definition Classes
- Tapir
- implicit def traversableModifyFunctor[F[_], A](implicit fac: Factory[A, F[A]], ev: (F[A]) => Iterable[A]): ModifyFunctor[F, A]
- Definition Classes
- ModifyMacroSupport
- def webSocketBody[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat]: WebSocketBodyBuilder[REQ, REQ_CF, RESP, RESP_CF]
- Definition Classes
- Tapir
- def webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
- Definition Classes
- Tapir
- def xmlBody[T](implicit arg0: XmlCodec[T]): Body[String, T]
- Definition Classes
- Tapir
Deprecated Value Members
- def statusDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.18) Use oneOfDefaultMapping
- 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
- def statusMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfMapping[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.18) Use oneOfMappingClassMatcher
- 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
- 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
- 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