trait ChunkedEntities extends algebra.ChunkedEntities with EndpointsWithCustomErrors
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- ChunkedEntities
- EndpointsWithCustomErrors
- Methods
- Urls
- StatusCodes
- ChunkedEntities
- ChunkedResponseEntities
- ChunkedRequestEntities
- Chunks
- EndpointsWithCustomErrors
- Errors
- Responses
- StatusCodes
- Requests
- SemigroupalSyntax
- Methods
- Urls
- PartialInvariantFunctorSyntax
- InvariantFunctorSyntax
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
-
final
class
CallbackDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
-
type
CallbacksDocs = Map[String, CallbackDocs]
- Definition Classes
- EndpointsWithCustomErrors
-
type
Chunks[A] = Stream[Effect, A]
- Definition Classes
- ChunkedEntities → Chunks
-
abstract
type
ClientErrors
- Definition Classes
- Errors
-
abstract
type
Effect[A]
- Definition Classes
- EndpointsWithCustomErrors
-
final
class
EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
-
implicit final
class
EndpointSyntax[A, B] extends AnyRef
- Definition Classes
- EndpointsWithCustomErrors
-
implicit
class
InvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- InvariantFunctorSyntax
-
type
Method = org.http4s.Method
- Definition Classes
- Methods → Methods
-
implicit
class
PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- PartialInvariantFunctorSyntax
-
implicit
class
PathOps[A] extends AnyRef
- Definition Classes
- Urls
-
type
QueryString[A] = (A) ⇒ Query
- Definition Classes
- Urls → Urls
-
implicit
class
QueryStringSyntax[A] extends AnyRef
- Definition Classes
- Urls
-
type
Request[A] = (A) ⇒ Effect[org.http4s.Request[Effect]]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
type
RequestEntity[A] = (A, org.http4s.Request[Effect]) ⇒ org.http4s.Request[Effect]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
class
RequestEntitySyntax[A] extends AnyRef
- Definition Classes
- Requests
-
type
RequestHeaders[A] = (A, org.http4s.Request[Effect]) ⇒ org.http4s.Request[Effect]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit final
class
RequestSyntax[A] extends AnyRef
- Definition Classes
- Requests
-
type
Response[A] = (StatusCode, Headers) ⇒ Option[ResponseEntity[A]]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
type
ResponseEntity[A] = (org.http4s.Response[Effect]) ⇒ Effect[A]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
type
ResponseHeaders[A] = (Headers) ⇒ Validated[A]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
class
ResponseSyntax[A] extends AnyRef
- Definition Classes
- Responses
-
implicit
class
SemigroupalSyntax[A, F[_]] extends AnyRef
- Definition Classes
- SemigroupalSyntax
-
abstract
type
ServerError
- Definition Classes
- Errors
-
type
StatusCode = Status
- Definition Classes
- StatusCodes → StatusCodes
-
type
WithDefault[A] = Option[A]
- Definition Classes
- Urls → Urls
-
final
class
Endpoint[A, B] extends AnyRef
- Definition Classes
- EndpointsWithCustomErrors
-
trait
Path[A] extends Url[A]
- Definition Classes
- Urls
-
trait
QueryStringParam[A] extends AnyRef
- Definition Classes
- Urls
-
trait
Segment[A] extends AnyRef
- Definition Classes
- Urls
-
trait
Url[A] extends AnyRef
- Definition Classes
- Urls
Abstract Value Members
-
abstract
def
authority: Authority
The authority to use to access the endpoints
The authority to use to access the endpoints
- Definition Classes
- EndpointsWithCustomErrors
-
abstract
def
client: Client[Effect]
- Definition Classes
- EndpointsWithCustomErrors
-
abstract
def
clientErrorsResponseEntity: ResponseEntity[ClientErrors]
- Definition Classes
- Errors
-
abstract
def
clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
- Definition Classes
- Errors
-
implicit abstract
def
effect: Concurrent[Effect]
- Definition Classes
- EndpointsWithCustomErrors
-
abstract
def
invalidToClientErrors(invalid: Invalid): ClientErrors
- Definition Classes
- Errors
-
abstract
def
scheme: Scheme
The scheme to use to access the endpoints
The scheme to use to access the endpoints
- Definition Classes
- EndpointsWithCustomErrors
-
abstract
def
serverErrorResponseEntity: ResponseEntity[ServerError]
- Definition Classes
- Errors
-
abstract
def
serverErrorToThrowable(serverError: ServerError): Throwable
- Definition Classes
- Errors
-
abstract
def
throwableToServerError(throwable: Throwable): ServerError
- Definition Classes
- Errors
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
Accepted: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
AlreadyReported: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
BadRequest: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Conflict: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Created: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Delete: Method
- Definition Classes
- Methods → Methods
-
def
ExpectationFailed: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
FailedDependency: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Forbidden: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Get: Method
- Definition Classes
- Methods → Methods
-
def
Gone: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
IMUsed: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
InternalServerError: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
LengthRequired: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Locked: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
MethodNotAllowed: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
MisdirectedRequest: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
MultiStatus: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
NoContent: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
NonAuthoritativeInformation: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotAcceptable: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotFound: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotImplemented: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotModified: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
OK: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Options: Method
- Definition Classes
- Methods → Methods
-
def
PartialContent: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Patch: Method
- Definition Classes
- Methods → Methods
-
def
PayloadTooLarge: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
PaymentRequired: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
PermanentRedirect: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Post: Method
- Definition Classes
- Methods → Methods
-
def
PreconditionFailed: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
PreconditionRequired: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
ProxyAuthenticationRequired: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Put: Method
- Definition Classes
- Methods → Methods
-
def
RangeNotSatisfiable: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
RequestHeaderFieldsTooLarge: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
RequestTimeout: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
ResetContent: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
TemporaryRedirect: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
TooEarly: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
TooManyRequests: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
Unauthorized: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
UnavailableForLegalReasons: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
UnprocessableEntity: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
UnsupportedMediaType: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
UpgradeRequired: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
UriTooLong: Status
- Definition Classes
- StatusCodes → StatusCodes
-
def
addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
- Definition Classes
- Responses
-
implicit
def
booleanQueryString: QueryStringParam[Boolean]
- Definition Classes
- Urls
-
def
bytesChunksRequest: (Chunks[Array[Byte]], org.http4s.Request[Effect]) ⇒ org.http4s.Request[Effect]
- Definition Classes
- ChunkedEntities → ChunkedRequestEntities
-
def
bytesChunksResponse: (org.http4s.Response[Effect]) ⇒ Effect[Chunks[Array[Byte]]]
- Definition Classes
- ChunkedEntities → ChunkedResponseEntities
-
def
chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
- Definition Classes
- Urls → Urls
-
def
choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
lazy val
clientErrorsResponse: Response[ClientErrors]
- Definition Classes
- Errors
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
- Definition Classes
- Urls → Urls
-
final
def
delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
implicit
def
doubleQueryString: QueryStringParam[Double]
- Definition Classes
- Urls
-
implicit
def
doubleSegment: Segment[Double]
- Definition Classes
- Urls
-
def
emptyRequest: RequestEntity[Unit]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
emptyRequestHeaders: RequestHeaders[Unit]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
emptyResponse: ResponseEntity[Unit]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
emptyResponseHeaders: ResponseHeaders[Unit]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
implicit
def
intQueryString: QueryStringParam[Int]
- Definition Classes
- Urls
-
implicit
def
intSegment: Segment[Int]
- Definition Classes
- Urls
-
final
def
internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
- Definition Classes
- Responses
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
implicit
def
longQueryString: QueryStringParam[Long]
- Definition Classes
- Urls
-
implicit
def
longSegment: Segment[Long]
- Definition Classes
- Urls
-
def
mapEndpointDocs[A, B](currentEndpoint: Endpoint[A, B], func: (EndpointDocs) ⇒ EndpointDocs): Endpoint[A, B]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
-
def
mapEndpointRequest[A, B, C](currentEndpoint: Endpoint[A, B], func: (Request[A]) ⇒ Request[C]): Endpoint[C, B]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
-
def
mapEndpointResponse[A, B, C](currentEndpoint: Endpoint[A, B], func: (Response[B]) ⇒ Response[C]): Endpoint[A, C]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
- Definition Classes
- Responses
-
def
optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
- Definition Classes
- Urls → Urls
-
def
optRequestHeader(name: String, docs: Option[String]): RequestHeaders[Option[String]]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
optResponseHeader(name: String, docs: Option[String]): ResponseHeaders[Option[String]]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
- Definition Classes
- Urls → Urls
-
final
def
patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
val
path: Path[Unit]
- Definition Classes
- Urls
-
implicit
lazy val
pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
- Definition Classes
- Urls → Urls
-
final
def
post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
final
def
put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
def
qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
- Definition Classes
- Urls → Urls
-
def
queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
- Definition Classes
- Urls → Urls
-
def
queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
- Definition Classes
- Urls → Urls
-
def
remainingSegments(name: String, docs: Documentation): Path[String]
- Definition Classes
- Urls → Urls
-
def
repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]
- Definition Classes
- Urls → Urls
-
def
request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
def
requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
requestHeader(name: String, docs: Option[String]): RequestHeaders[String]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
def
requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
def
requestHeadersSemigroupal: Semigroupal[RequestHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
def
requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
responseHeader(name: String, docs: Option[String]): ResponseHeaders[String]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
responseInvariantFunctor: InvariantFunctor[Response]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
- Definition Classes
- Urls → Urls
-
def
segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
- Definition Classes
- Urls → Urls
-
lazy val
serverErrorResponse: Response[ServerError]
- Definition Classes
- Errors
-
def
staticPathSegment(segment: String): Path[Unit]
- Definition Classes
- Urls → Urls
-
def
stringQueryString: QueryStringParam[String]
- Definition Classes
- Urls → Urls
-
def
stringSegment: Segment[String]
- Definition Classes
- Urls → Urls
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
textChunksRequest: (Chunks[String], org.http4s.Request[Effect]) ⇒ org.http4s.Request[Effect]
- Definition Classes
- ChunkedEntities → ChunkedRequestEntities
-
def
textChunksResponse: (org.http4s.Response[Effect]) ⇒ Effect[Chunks[String]]
- Definition Classes
- ChunkedEntities → ChunkedResponseEntities
-
def
textRequest: RequestEntity[String]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
textResponse: ResponseEntity[String]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
- Definition Classes
- Urls → Urls
-
def
urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
- Definition Classes
- Urls → Urls
-
implicit
def
uuidQueryString: QueryStringParam[UUID]
- Definition Classes
- Urls
-
implicit
def
uuidSegment: Segment[UUID]
- Definition Classes
- Urls
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
- Definition Classes
- Responses