object UriTemplate extends Serializable
- Source
- UriTemplate.scala
- Alphabetic
- By Inheritance
- UriTemplate
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
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.
- type Fragment = List[FragmentDef]
- sealed trait FragmentDef extends AnyRef
-
final
case class
FragmentElm(value: String) extends FragmentDef with Product with Serializable
Static fragment element
-
final
case class
MultiFragmentExp(names: List[String]) extends FragmentDef with Product with Serializable
Fragment expansion with multiple variables, crosshatch-prefixed (Section 3.2.4)
-
final
case class
ParamContExp(names: List[String]) extends QueryExp with Product with Serializable
Form-style query continuation (Section 3.2.9)
-
final
case class
ParamElm(name: String, values: List[String]) extends QueryDef with Product with Serializable
Static query parameter element
-
final
case class
ParamExp(names: List[String]) extends QueryExp with Product with Serializable
Form-style query, ampersand-separated (Section 3.2.8)
-
final
case class
ParamReservedExp(name: String, variables: List[String]) extends QueryDef with Product with Serializable
Reserved string expansion for query parameter
-
final
case class
ParamVarExp(name: String, variables: List[String]) extends QueryDef with Product with Serializable
Simple string expansion for query parameter
- type Path = List[PathDef]
- sealed trait PathDef extends AnyRef
-
final
case class
PathElm(value: String) extends PathDef with Product with Serializable
Static path element
-
final
case class
PathExp(names: List[String]) extends PathDef with Product with Serializable
Path segments, slash-prefixed (Section 3.2.6)
- type Query = List[QueryDef]
- sealed trait QueryDef extends AnyRef
- sealed trait QueryExp extends QueryDef
-
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)
-
final
case class
SimpleFragmentExp(name: String) extends FragmentDef with Product with Serializable
Fragment expansion, crosshatch-prefixed (Section 3.2.4)
-
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
-
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
-
def
buildQuery(q: Query): http4s.Query
- Attributes
- protected
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
containsExpansions(t: UriTemplate): Boolean
- Attributes
- protected
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
expandFragmentN(fragment: Fragment, name: String, value: String): Fragment
- Attributes
- protected
-
def
expandPathN(path: Path, name: String, values: List[QueryParameterValue]): Path
- Attributes
- protected
-
def
expandQueryN(query: Query, name: String, values: List[String]): Query
- Attributes
- protected
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fragmentExp(f: FragmentDef): Boolean
- Attributes
- protected
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isUnreserved(s: String): Boolean
- def isUnreservedOrEncoded(s: String): Boolean
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
pathExp(p: PathDef): Boolean
- Attributes
- protected
-
def
queryExp(q: QueryDef): Boolean
- Attributes
- protected
-
def
renderAuthority(a: Authority): String
- Attributes
- protected
-
def
renderFragment(f: Fragment): String
- Attributes
- protected
-
def
renderFragmentIdentifier(f: Fragment): String
- Attributes
- protected
-
def
renderHost(h: Host): String
- Attributes
- protected
-
def
renderPath(p: Path): String
- Attributes
- protected
-
def
renderPathAndQueryAndFragment(t: UriTemplate): String
- Attributes
- protected
-
def
renderQuery(ps: Query): String
- Attributes
- protected
-
def
renderScheme(s: Scheme): String
- Attributes
- protected
-
def
renderSchemeAndAuthority(t: UriTemplate): String
- Attributes
- protected
-
def
renderUriTemplate(t: UriTemplate): String
- Attributes
- protected
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
toUri(t: UriTemplate): Uri
- Attributes
- protected
-
val
unreserved: Set[Char]
- Attributes
- protected
-
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( ... ) @native()
- object MultiFragmentExp extends Serializable
- object ParamContExp extends Serializable
- object ParamElm extends Serializable
- object ParamExp extends Serializable
- object ParamReservedExp extends Serializable
- object ParamVarExp extends Serializable
- object PathExp extends Serializable
- object ReservedExp extends Serializable
- object VarExp extends Serializable