Urls

Type Members

abstract type Path[A] <: Url[A]

An URL path carrying an A information
implicit class PathOps[A] extends AnyRef

Convenient methods for Paths.
abstract type QueryString[A]

A query string carrying an A information
A query string carrying an A information
QueryString values can be created with the qs operation, and can be combined with the & operation:
```
val queryPageAndLang: QueryString[(Int, Option[String])] =
  qs[Int]("page") & qs[Option[String]]("lang")
```
implicit class QueryStringOps[A] extends AnyRef

Provides convenient methods on QueryString.
abstract type QueryStringParam[A]

A single query string parameter carrying an A information.
abstract type Segment[A]

An URL path segment carrying an A information.
abstract type Url[A]

An URL carrying an A information

Abstract Value Members

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

Chains the two paths
abstract def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Concatenates two QueryStrings
implicit abstract def intSegment: Segment[Int]

Ability to define Int path segments
implicit abstract def longSegment: Segment[Long]

Segment containing a Long value
implicit abstract def optionalQueryStringParam[A](implicit arg0: QueryStringParam[A]): QueryStringParam[Option[A]]

Make a query string parameter optional:
Make a query string parameter optional:
```
path / "articles" /? qs[Option[Int]]("page")
```
Client interpreters must omit optional query string parameters that are empty. Server interpreters must accept incoming requests whose optional query string parameters are missing. Server interpreters must report a failure for incoming requests whose optional query string parameters are present, but malformed.
abstract def qs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[A]

Builds a QueryString with one parameter.
Builds a QueryString with one parameter.
Examples:
```
qs[Int]("page")            // mandatory `page` parameter
qs[Option[String]]("lang") // optional `lang` parameter
qs[List[Long]]("id")       // repeated `id` parameter
```
A
Type of the value carried by the parameter
name
Parameter’s name
abstract def refineQueryStringParam[A, B](pa: QueryStringParam[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): QueryStringParam[B]

Ability to refine a query string parameter for a type A into a query string parameter for a type B given a pair of decoding/encoding functions between A and B.
Ability to refine a query string parameter for a type A into a query string parameter for a type B given a pair of decoding/encoding functions between A and B.
A
The type of the available query string parameter.
B
The type of the desired query string parameter.
pa
A query string parameter for a type A
f
Decoding function from A to Option[B]
g
Encoding function from B to A
returns
A query string parameter for a type B built by refinement from pa.
abstract def refineSegment[A, B](sa: Segment[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): Segment[B]

Ability to refine a path segment for a type A into a path segment for a type B given a pair of decoding/encoding functions between A and B.
Ability to refine a path segment for a type A into a path segment for a type B given a pair of decoding/encoding functions between A and B.
A
The type of the available path segment.
B
The type of the desired path segment.
sa
A path segment for a type A
f
Decoding function from A to Option[B]
g
Encoding function from B to A
returns
A path segment for a type B built by refinement from sa.
implicit abstract def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit arg0: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

Support query string parameters with multiple values:
Support query string parameters with multiple values:
```
path / "articles" /? qs[List[Long]]("id")
```
Server interpreters must accept incoming requests where such parameters are missing (in such a case, its value is an empty collection), and report a failure if at least one value is malformed.
abstract def segment[A](name: String = "", docs: Documentation = None)(implicit s: Segment[A]): Path[A]

Builds a path segment carrying an A information
abstract def staticPathSegment(segment: String): Path[Unit]

Builds a static path segment
implicit abstract def stringQueryString: QueryStringParam[String]

Ability to define String query string parameters
implicit abstract def stringSegment: Segment[String]

Ability to define String path segments
implicit abstract def urlInvFunctor: InvariantFunctor[Url]
abstract def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Builds an URL from the given path and query string

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit def booleanQueryString: QueryStringParam[Boolean]

Query string parameter containing a Boolean value
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit def doubleQueryString: QueryStringParam[Double]
implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

Implicit conversion to get rid of intellij errors when defining paths.
Implicit conversion to get rid of intellij errors when defining paths. Effectively should not be called.
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 getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
implicit def intQueryString: QueryStringParam[Int]

Ability to define Int query string parameters
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: Path[Unit]

An empty path.
An empty path.
Useful to begin a path definition:
```
path / "foo" / segment[Int] /? qs[String]("bar")
```
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
implicit def uuidQueryString: QueryStringParam[UUID]

Ability to define UUID query string parameters
implicit def uuidSegment: Segment[UUID]

Ability to define UUID path segments
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( ... )

Related Doc: package algebra

trait Urls extends AnyRef

Type Members

abstract type Path[A] <: Url[A]

implicit class PathOps[A] extends AnyRef

abstract type QueryString[A]

implicit class QueryStringOps[A] extends AnyRef

abstract type QueryStringParam[A]

abstract type Segment[A]

abstract type Url[A]

Abstract Value Members

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

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

implicit abstract def intSegment: Segment[Int]

implicit abstract def longSegment: Segment[Long]

implicit abstract def optionalQueryStringParam[A](implicit arg0: QueryStringParam[A]): QueryStringParam[Option[A]]

abstract def qs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[A]

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

abstract def refineSegment[A, B](sa: Segment[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): Segment[B]

implicit abstract def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit arg0: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

abstract def segment[A](name: String = "", docs: Documentation = None)(implicit s: Segment[A]): Path[A]

abstract def staticPathSegment(segment: String): Path[Unit]

implicit abstract def stringQueryString: QueryStringParam[String]

implicit abstract def stringSegment: Segment[String]

implicit abstract def urlInvFunctor: InvariantFunctor[Url]

abstract def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

implicit def booleanQueryString: QueryStringParam[Boolean]

def clone(): AnyRef

implicit def doubleQueryString: QueryStringParam[Double]

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

implicit def intQueryString: QueryStringParam[Int]

final def isInstanceOf[T0]: Boolean

implicit def longQueryString: QueryStringParam[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: Path[Unit]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

implicit def uuidQueryString: QueryStringParam[UUID]

implicit def uuidSegment: Segment[UUID]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped