MuxEndpoints

Type Members

implicit class Directive0Ops extends AnyRef

Definition Classes
Urls
case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable

Definition Classes
Endpoints
implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
InvariantFunctorSyntax
type Method = HttpMethod

Definition Classes
Methods → Methods
class MuxEndpoint[Req <: MuxRequest, Resp, Transport] extends AnyRef
implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
PartialInvariantFunctorSyntax
class Path[T] extends Url[T]

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Definition Classes
Urls
class QueryString[T] extends AnyRef

Definition Classes
Urls
implicit class QueryStringOps[A] extends AnyRef

Definition Classes
Urls
type QueryStringParam[T] = (String, Map[String, Seq[String]]) ⇒ Option[T]

<invalid inheritdoc annotation>
<invalid inheritdoc annotation>
Given a parameter name and a query string content, returns a decoded parameter value of type T, or None if decoding failed

Definition Classes
Urls → Urls
type Request[A] = Directive[(A)]

Definition Classes
Endpoints → Requests
type RequestEntity[A] = Directive[(A)]

Definition Classes
Endpoints → Requests
type RequestHeaders[A] = Directive[(A)]

Definition Classes
Endpoints → Requests
type Response[A] = (A) ⇒ Route

Definition Classes
Endpoints → Responses
implicit class ResponseExtensions[A] extends AnyRef

Definition Classes
Responses
type Segment[T] = PathMatcher[(T)]

Definition Classes
Urls → Urls
implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

Definition Classes
SemigroupalSyntax
type StatusCode = akka.http.scaladsl.model.StatusCode

Definition Classes
StatusCodes → StatusCodes
class Url[T] extends AnyRef

Definition Classes
Urls

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 BadRequest: ClientError

Definition Classes
StatusCodes → StatusCodes
def Delete: HttpMethod

Definition Classes
Methods → Methods
def Get: HttpMethod

Definition Classes
Methods → Methods
def NotFound: ClientError

Definition Classes
StatusCodes → StatusCodes
def OK: Success

Definition Classes
StatusCodes → StatusCodes
def Options: HttpMethod

Definition Classes
Methods → Methods
def Patch: HttpMethod

Definition Classes
Methods → Methods
def Post: HttpMethod

Definition Classes
Methods → Methods
def Put: HttpMethod

Definition Classes
Methods → Methods
def Unauthorized: ClientError

Definition Classes
StatusCodes → StatusCodes
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit def booleanQueryString: QueryStringParam[Boolean]

Definition Classes
Urls
def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Definition Classes
Urls → Urls
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Definition Classes
Urls → Urls
def convToDirective1(directive: Directive0): Directive1[Unit]

Attributes
protected
Definition Classes
Urls
final def delete[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

Definition Classes
Requests
lazy val directive1InvFunctor: InvariantFunctor[Directive1]

Definition Classes
Endpoints
implicit def doubleQueryString: QueryStringParam[Double]

Definition Classes
Urls
implicit def doubleSegment: Segment[Double]

Definition Classes
Urls
implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

Definition Classes
Urls
def emptyHeaders: RequestHeaders[Unit]

Definition Classes
Endpoints → Requests
def emptyRequest: RequestEntity[Unit]

Definition Classes
Endpoints → Requests
def emptyResponse(docs: Documentation): Response[Unit]

Definition Classes
Endpoints → Responses
def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation = None, description: Documentation = None, tags: List[String] = Nil): Endpoint[A, B]

Definition Classes
Endpoints → Endpoints
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

Definition Classes
Requests
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def header(name: String, docs: Documentation): RequestHeaders[String]

Definition Classes
Endpoints → Requests
implicit def intQueryString: QueryStringParam[Int]

Definition Classes
Urls
implicit def intSegment: Segment[Int]

Definition Classes
Urls
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def joinDirectives[T1, T2](dir1: Directive1[T1], dir2: Directive1[T2])(implicit tupler: Tupler[T1, T2]): Directive1[Out]

Simpler alternative to Directive.&() method
Simpler alternative to Directive.&() method

Attributes
protected
Definition Classes
Urls
implicit def longQueryString: QueryStringParam[Long]

Definition Classes
Urls
implicit def longSegment: Segment[Long]

Definition Classes
Urls
def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]

Definition Classes
MuxEndpoints → MuxEndpoints
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

Definition Classes
Endpoints → Requests
implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

Definition Classes
Urls → Urls
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], 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], 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 param: QueryStringParam[A]): QueryString[A]

Definition Classes
Urls → Urls
implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

Definition Classes
Urls → Urls
implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

Definition Classes
Urls → Urls
def refineQueryStringParam[A, B](pa: QueryStringParam[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): QueryStringParam[B]

Definition Classes
Urls
def remainingSegments(name: String, docs: Documentation): Path[String]

Definition Classes
Urls → Urls
implicit 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
implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

Definition Classes
Endpoints → Requests
implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

Definition Classes
Endpoints → Requests
implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

Definition Classes
Endpoints → Requests
def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

Definition Classes
Endpoints → Requests
def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

Definition Classes
Urls → Urls
implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

Definition Classes
Urls → Urls
def staticPathSegment(segment: String): Path[Unit]

Definition Classes
Urls → Urls
implicit lazy val stringQueryString: QueryStringParam[String]

Definition Classes
Urls → Urls
implicit def stringSegment: Segment[String]

Definition Classes
Urls → Urls
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def textRequest(docs: Documentation): RequestEntity[String]

Definition Classes
Endpoints → Requests
def textResponse(docs: Documentation): Response[String]

Definition Classes
Endpoints → Responses
def toString(): String

Definition Classes
AnyRef → Any
implicit lazy val urlPartialInvFunctor: 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(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def wheneverFound[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

Definition Classes
Endpoints → Responses

Related Doc: package server

trait MuxEndpoints extends algebra.MuxEndpoints with Endpoints

Type Members

implicit class Directive0Ops extends AnyRef

case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable

implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

type Method = HttpMethod

class MuxEndpoint[Req <: MuxRequest, Resp, Transport] extends AnyRef

implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

class Path[T] extends Url[T]

implicit class PathOps[A] extends AnyRef

class QueryString[T] extends AnyRef

implicit class QueryStringOps[A] extends AnyRef

type QueryStringParam[T] = (String, Map[String, Seq[String]]) ⇒ Option[T]

type Request[A] = Directive[(A)]

type RequestEntity[A] = Directive[(A)]

type RequestHeaders[A] = Directive[(A)]

type Response[A] = (A) ⇒ Route

implicit class ResponseExtensions[A] extends AnyRef

type Segment[T] = PathMatcher[(T)]

implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

type StatusCode = akka.http.scaladsl.model.StatusCode

class Url[T] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def BadRequest: ClientError

def Delete: HttpMethod

def Get: HttpMethod

def NotFound: ClientError

def OK: Success

def Options: HttpMethod

def Patch: HttpMethod

def Post: HttpMethod

def Put: HttpMethod

def Unauthorized: ClientError

final def asInstanceOf[T0]: T0

implicit def booleanQueryString: QueryStringParam[Boolean]

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

def clone(): AnyRef

def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

def convToDirective1(directive: Directive0): Directive1[Unit]

final def delete[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

lazy val directive1InvFunctor: InvariantFunctor[Directive1]

implicit def doubleQueryString: QueryStringParam[Double]

implicit def doubleSegment: Segment[Double]

implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

def emptyHeaders: RequestHeaders[Unit]

def emptyRequest: RequestEntity[Unit]

def emptyResponse(docs: Documentation): Response[Unit]

def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation = None, description: Documentation = None, tags: List[String] = Nil): Endpoint[A, B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def get[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

final def getClass(): Class[_]

def hashCode(): Int

def header(name: String, docs: Documentation): RequestHeaders[String]

implicit def intQueryString: QueryStringParam[Int]

implicit def intSegment: Segment[Int]

final def isInstanceOf[T0]: Boolean

def joinDirectives[T1, T2](dir1: Directive1[T1], dir2: Directive1[T2])(implicit tupler: Tupler[T1, T2]): Directive1[Out]

implicit def longQueryString: QueryStringParam[Long]

implicit def longSegment: Segment[Long]

def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

val path: Path[Unit]

implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]

implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

def refineQueryStringParam[A, B](pa: QueryStringParam[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): QueryStringParam[B]