org.http4s

UriTemplate

object UriTemplate extends Serializable

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UriTemplate
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait ExpansionType extends AnyRef

    URI Templates are similar to a macro language with a fixed set of macro definitions: the expression type determines the expansion process.

    URI Templates are similar to a macro language with a fixed set of macro definitions: the expression type determines the expansion process.

    The default expression type is simple string expansion (Level 1), wherein a single named variable is replaced by its value as a string after pct-encoding any characters not in the set of unreserved URI characters (Section 1.5).

    Level 2 templates add the plus ("+") operator, for expansion of values that are allowed to include reserved URI characters (Section 1.5), and the crosshatch ("#") operator for expansion of fragment identifiers.

    Level 3 templates allow multiple variables per expression, each separated by a comma, and add more complex operators for dot-prefixed labels, slash-prefixed path segments, semicolon-prefixed path parameters, and the form-style construction of a query syntax consisting of name=value pairs that are separated by an ampersand character.

  2. type Fragment = List[FragmentDef]

  3. sealed trait FragmentDef extends AnyRef

  4. case class FragmentElm(value: String) extends FragmentDef with Product with Serializable

    Static fragment element

  5. case class MultiFragmentExp(names: List[String]) extends FragmentDef with Product with Serializable

    Fragment expansion with multiple variables, crosshatch-prefixed (Section 3.2.4)

    Fragment expansion with multiple variables, crosshatch-prefixed (Section 3.2.4)

  6. case class ParamContExp(names: List[String]) extends QueryExp with Product with Serializable

    Form-style query continuation (Section 3.2.9)

    Form-style query continuation (Section 3.2.9)

  7. case class ParamElm(name: String, values: List[String]) extends QueryDef with Product with Serializable

    Static query parameter element

  8. case class ParamExp(names: List[String]) extends QueryExp with Product with Serializable

    Form-style query, ampersand-separated (Section 3.2.8)

    Form-style query, ampersand-separated (Section 3.2.8)

  9. case class ParamReservedExp(name: String, variables: List[String]) extends QueryDef with Product with Serializable

    Reserved string expansion for query parameter

  10. case class ParamVarExp(name: String, variables: List[String]) extends QueryDef with Product with Serializable

    Simple string expansion for query parameter

  11. type Path = List[PathDef]

  12. sealed trait PathDef extends AnyRef

  13. case class PathElm(value: String) extends PathDef with Product with Serializable

    Static path element

  14. case class PathExp(names: List[String]) extends PathDef with Product with Serializable

    Path segments, slash-prefixed (Section 3.2.6)

    Path segments, slash-prefixed (Section 3.2.6)

  15. type Query = List[QueryDef]

  16. sealed trait QueryDef extends AnyRef

  17. sealed trait QueryExp extends QueryDef

  18. case class ReservedExp(names: List[String]) extends PathDef with Product with Serializable

    Level 2 allows reserved string expansion (Section 3.2.3)

    Level 2 allows reserved string expansion (Section 3.2.3)

    Level 3 allows reserved expansion with multiple variables (Section 3.2.3)

  19. case class SimpleFragmentExp(name: String) extends FragmentDef with Product with Serializable

    Fragment expansion, crosshatch-prefixed (Section 3.2.4)

    Fragment expansion, crosshatch-prefixed (Section 3.2.4)

  20. case class VarExp(names: List[String]) extends PathDef with Product with Serializable

    Level 1 allows string expansion (Section 3.2.2)

    Level 1 allows string expansion (Section 3.2.2)

    Level 3 allows string expansion with multiple variables (Section 3.2.2)

Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. object MultiFragmentExp extends Serializable

  5. object ParamContExp extends Serializable

  6. object ParamElm extends Serializable

  7. object ParamExp extends Serializable

  8. object ParamReservedExp extends Serializable

  9. object ParamVarExp extends Serializable

  10. object PathExp extends Serializable

  11. object ReservedExp extends Serializable

  12. object VarExp extends Serializable

  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  14. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  15. def containsExpansions(t: UriTemplate): Boolean

    Attributes
    protected

  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  18. def expandFragmentN(fragment: Option[Fragment], name: String, value: String): Option[Fragment]

    Attributes
    protected

  19. def expandPathN(path: Path, name: String, values: List[String]): Path

    Attributes
    protected

  20. def expandQueryN(query: Option[Query], name: String, values: List[String]): Option[Query]

    Attributes
    protected

  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  22. def fragmentExp(f: FragmentDef): Boolean

    Attributes
    protected

  23. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  26. def isUnreserved(s: String): Boolean

  27. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  30. def pathExp(p: PathDef): Boolean

    Attributes
    protected

  31. def queryExp(q: QueryDef): Boolean

    Attributes
    protected

  32. def renderAuthority(a: Authority): String

    Attributes
    protected

  33. def renderFragment(f: Fragment): String

    Attributes
    protected

  34. def renderFragmentIdentifier(f: Fragment): String

    Attributes
    protected

  35. def renderHost(h: Host): String

    Attributes
    protected

  36. def renderParams(q: Query): String

    Attributes
    protected

  37. def renderPath(p: Path): String

    Attributes
    protected

  38. def renderPathAndQueryAndFragment(t: UriTemplate): String

    Attributes
    protected

  39. def renderQuery(q: Query): String

    Attributes
    protected

  40. def renderScheme(s: Scheme): String

    Attributes
    protected

  41. def renderSchemeAndAuthority(t: UriTemplate): String

    Attributes
    protected

  42. def renderUriTemplate(t: UriTemplate): String

    Attributes
    protected

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

    Definition Classes
    AnyRef

  44. def toString(): String

    Definition Classes
    AnyRef → Any

  45. def toUri(t: UriTemplate): Uri

    Attributes
    protected

  46. val unreserved: Set[Char]

    Attributes
    protected

  47. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  49. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped