Packages

object UriTemplate extends Serializable

Source
UriTemplate.scala
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
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. final case class FragmentElm(value: String) extends FragmentDef with Product with Serializable

    Static fragment element

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

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

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

    Form-style query continuation (Section 3.2.9)

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

    Static query parameter element

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

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

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

    Reserved string expansion for query parameter

  10. final 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. final case class PathElm(value: String) extends PathDef with Product with Serializable

    Static path element

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

    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. final 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. final case class SimpleFragmentExp(name: String) extends FragmentDef with Product with Serializable

    Fragment expansion, crosshatch-prefixed (Section 3.2.4)

  20. final 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def buildQuery(q: Query): http4s.Query
    Attributes
    protected
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def containsExpansions(t: UriTemplate): Boolean
    Attributes
    protected
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def expandFragmentN(fragment: Fragment, name: String, value: String): Fragment
    Attributes
    protected
  11. def expandPathN(path: Path, name: String, values: List[QueryParameterValue]): Path
    Attributes
    protected
  12. def expandQueryN(query: Query, name: String, values: List[String]): Query
    Attributes
    protected
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def fragmentExp(f: FragmentDef): Boolean
    Attributes
    protected
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isUnreserved(s: String): Boolean
  19. def isUnreservedOrEncoded(s: String): Boolean
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def pathExp(p: PathDef): Boolean
    Attributes
    protected
  24. def queryExp(q: QueryDef): Boolean
    Attributes
    protected
  25. def renderAuthority(a: Authority): String
    Attributes
    protected
  26. def renderFragment(f: Fragment): String
    Attributes
    protected
  27. def renderFragmentIdentifier(f: Fragment): String
    Attributes
    protected
  28. def renderHost(h: Host): String
    Attributes
    protected
  29. def renderPath(p: Path): String
    Attributes
    protected
  30. def renderPathAndQueryAndFragment(t: UriTemplate): String
    Attributes
    protected
  31. def renderQuery(ps: Query): String
    Attributes
    protected
  32. def renderScheme(s: Scheme): String
    Attributes
    protected
  33. def renderSchemeAndAuthority(t: UriTemplate): String
    Attributes
    protected
  34. def renderUriTemplate(t: UriTemplate): String
    Attributes
    protected
  35. def renderUserInfo(u: UserInfo): String
    Attributes
    protected
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. def toUri(t: UriTemplate): Uri
    Attributes
    protected
  39. val unreserved: Set[Char]
    Attributes
    protected
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. object MultiFragmentExp extends Serializable
  44. object ParamContExp extends Serializable
  45. object ParamElm extends Serializable
  46. object ParamExp extends Serializable
  47. object ParamReservedExp extends Serializable
  48. object ParamVarExp extends Serializable
  49. object PathExp extends Serializable
  50. object ReservedExp extends Serializable
  51. object VarExp extends Serializable

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped