http4s-client/endpoints4s.http4s.client/Urls

Urls

trait Urls extends Urls with StatusCodes
trait Urls
class Object
trait Matchable
class Any
class Endpoints[F]

Type members

Classlikes

trait Path[A] extends Url[A]
trait QueryStringParam[A]
trait Segment[A]
trait Url[A]

Inherited classlikes

implicit class InvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: InvariantFunctor[F])

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Inherited from:
InvariantFunctorSyntax
implicit class PartialInvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: PartialInvariantFunctor[F])
implicit class PathOps[A](first: Path[A])

Convenient methods for Paths.

Convenient methods for Paths.

Inherited from:
Urls
implicit class QueryStringSyntax[A](first: QueryString[A])

Extension methods on QueryString.

Extension methods on QueryString.

Inherited from:
Urls

Types

type QueryString[A] = A => Query
type WithDefault[A] = Option[A]

Inherited types

type StatusCode = Status
Inherited from:
StatusCodes

Value members

Concrete methods

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
override def combineQueryStrings[A, B](first: () => A, second: () => B)(implicit tupler: Tupler[A, B]): () => Out
Definition Classes
override def optQsWithDefault[A](name: String, default: A, docs: Documentation)(implicit value: QueryStringParam[A]): () => Option[A]
Definition Classes
override def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
Definition Classes
override def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): () => A
Definition Classes
override def repeatedQueryStringParam[A, CC <: (Iterable)](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
Definition Classes
def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
override def stringQueryString: QueryStringParam[String]
Definition Classes
override def stringSegment: Segment[String]
Definition Classes
override def urlWithQueryString[A, B](path: Path[A], qs: () => B)(implicit tupler: Tupler[A, B]): Url[Out]
Definition Classes

Inherited methods

def Accepted: StatusCode
Inherited from:
StatusCodes
override def AlreadyReported: StatusCode
Definition Classes
Inherited from:
StatusCodes
def BadRequest: StatusCode
Inherited from:
StatusCodes
override def Conflict: StatusCode
Definition Classes
Inherited from:
StatusCodes
def Created: StatusCode
Inherited from:
StatusCodes
override def ExpectationFailed: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def FailedDependency: StatusCode
Definition Classes
Inherited from:
StatusCodes
def Forbidden: StatusCode
Inherited from:
StatusCodes
override def Gone: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def IMUsed: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def LengthRequired: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def Locked: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def MethodNotAllowed: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def MisdirectedRequest: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def MultiStatus: StatusCode
Definition Classes
Inherited from:
StatusCodes
def NoContent: StatusCode
Inherited from:
StatusCodes
override def NonAuthoritativeInformation: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def NotAcceptable: StatusCode
Definition Classes
Inherited from:
StatusCodes
def NotFound: StatusCode
Inherited from:
StatusCodes
override def NotModified: StatusCode
Definition Classes
Inherited from:
StatusCodes
def OK: StatusCode
Inherited from:
StatusCodes
override def PartialContent: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def PaymentRequired: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def PreconditionFailed: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def PreconditionRequired: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def ProxyAuthenticationRequired: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def RangeNotSatisfiable: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def RequestHeaderFieldsTooLarge: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def RequestTimeout: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def ResetContent: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def TooEarly: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def UnavailableForLegalReasons: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def UnprocessableEntity: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def UnsupportedMediaType: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def UpgradeRequired: StatusCode
Definition Classes
Inherited from:
StatusCodes
override def UriTooLong: StatusCode
Definition Classes
Inherited from:
StatusCodes

Inherited fields

val path: Path[Unit]

An empty path.

An empty path.

Useful to begin a path definition:

 path / "foo" / segment[Int] /? qs[String]("bar")
Inherited from:
Urls

Implicits

Implicits

Inherited implicits

final implicit def InvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: InvariantFunctor[F]): InvariantFunctorSyntax[A, F]

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Inherited from:
InvariantFunctorSyntax
final implicit def PartialInvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: PartialInvariantFunctor[F]): PartialInvariantFunctorSyntax[A, F]
final implicit def PathOps[A](first: Path[A]): PathOps[A]

Convenient methods for Paths.

Convenient methods for Paths.

Inherited from:
Urls
final implicit def QueryStringSyntax[A](first: () => A): QueryStringSyntax[A]

Extension methods on QueryString.

Extension methods on QueryString.

Inherited from:
Urls
implicit def booleanQueryString: QueryStringParam[Boolean]

Query string parameter containing a Boolean value

Query string parameter containing a Boolean value

Inherited from:
Urls
implicit def doubleQueryString: QueryStringParam[Double]

Codec for query string parameters of type Double

Codec for query string parameters of type Double

Inherited from:
Urls
implicit def doubleSegment: Segment[Double]

Path segment codec for type Double

Path segment codec for type Double

Inherited from:
Urls
implicit def intQueryString: QueryStringParam[Int]

Ability to define Int query string parameters

Ability to define Int query string parameters

Inherited from:
Urls
implicit def intSegment: Segment[Int]

Path segment codec for type Int

Path segment codec for type Int

Inherited from:
Urls
implicit def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value

Query string parameter containing a Long value

Inherited from:
Urls
implicit def longSegment: Segment[Long]

Path segment codec for type Long

Path segment codec for type Long

Inherited from:
Urls
implicit def uuidQueryString: QueryStringParam[UUID]

Ability to define UUID query string parameters

Ability to define UUID query string parameters

Inherited from:
Urls
implicit def uuidSegment: Segment[UUID]

Path segment codec for type UUID

Path segment codec for type UUID

Inherited from:
Urls