Trait

endpoints.documented.algebra

Urls

Related Doc: package algebra

Permalink

trait Urls extends AnyRef

Algebra interface for describing URL including documentation.

This interface is modeled after endpoints.algebra.Urls but some methods take additional parameters carrying the documentation part.

Source
Urls.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Urls
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    Permalink

    An URL path carrying an A information

  2. implicit class PathOps[A] extends AnyRef

    Permalink

    Convenient methods for Paths.

  3. abstract type QueryString[A]

    Permalink

    A query string carrying an A information

  4. implicit class QueryStringOps[A] extends AnyRef

    Permalink

    Provides convenient methods on QueryString.

  5. abstract type QueryStringParam[A]

    Permalink

    A single query string parameter carrying an A information.

  6. abstract type Segment[A]

    Permalink

    An URL path segment carrying an A information.

  7. abstract type Url[A]

    Permalink

    An URL carrying an A information

Abstract Value Members

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

    Permalink

    Chains the two paths

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

    Permalink

    Concatenates two QueryStrings

  3. implicit abstract def intQueryString: QueryStringParam[Int]

    Permalink

    Ability to define Int query string parameters

  4. implicit abstract def intSegment: Segment[Int]

    Permalink

    Ability to define Int path segments

  5. implicit abstract def longQueryString: QueryStringParam[Long]

    Permalink

    Query string parameter containing a Long value

  6. implicit abstract def longSegment: Segment[Long]

    Permalink

    Segment containing a Long value

  7. abstract def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

    Permalink

    Builds a QueryString with one optional parameter of type A.

    Builds a QueryString with one optional parameter of type A.

    name

    Parameter’s name

  8. abstract def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

    Permalink

    Builds a QueryString with one parameter.

    Builds a QueryString with one parameter.

    A

    Type of the value carried by the parameter

    name

    Parameter’s name

  9. abstract def segment[A](name: String)(implicit s: Segment[A]): Path[A]

    Permalink

    Builds a path segment carrying an A information

    Builds a path segment carrying an A information

    name

    Name for the segment (for documentation)

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

    Permalink

    Builds a static path segment

  11. implicit abstract def stringQueryString: QueryStringParam[String]

    Permalink

    Ability to define String query string parameters

  12. implicit abstract def stringSegment: Segment[String]

    Permalink

    Ability to define String path segments

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

    Permalink

    Builds an URL from the given path and query string

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. val path: Path[Unit]

    Permalink

    An empty path.

    An empty path.

    Useful to begin a path definition:

    path / "foo" / segment[Int]("some-value")
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped