UriTemplate

org.http4s.UriTemplate$
See theUriTemplate companion class

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Classlikes

sealed trait ExpansionType

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.

Attributes

Source:
UriTemplate.scala
Graph
Supertypes
class Object
trait Matchable
class Any
sealed trait FragmentDef

Attributes

Source:
UriTemplate.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class FragmentElm(value: String) extends FragmentDef

Static fragment element

Static fragment element

Attributes

Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class MultiFragmentExp(names: List[String]) extends FragmentDef

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

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

Attributes

Companion:
object
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ParamContExp(names: List[String]) extends QueryExp

Form-style query continuation (Section 3.2.9)

Form-style query continuation (Section 3.2.9)

Attributes

Companion:
object
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
trait QueryExp
trait QueryDef
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ParamElm(name: String, values: List[String]) extends QueryDef

Static query parameter element

Static query parameter element

Attributes

Companion:
object
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
trait QueryDef
class Object
trait Matchable
class Any
object ParamElm

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ParamExp(names: List[String]) extends QueryExp

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

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

Attributes

Companion:
object
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
trait QueryExp
trait QueryDef
class Object
trait Matchable
class Any
object ParamExp

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ParamReservedExp(name: String, variables: List[String]) extends QueryDef

Reserved string expansion for query parameter

Reserved string expansion for query parameter

Attributes

Companion:
object
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
trait QueryDef
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ParamVarExp(name: String, variables: List[String]) extends QueryDef

Simple string expansion for query parameter

Simple string expansion for query parameter

Attributes

Companion:
object
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
trait QueryDef
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait PathDef

Attributes

Source:
UriTemplate.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class PathElm
class PathExp
class VarExp
final case class PathElm(value: String) extends PathDef

Static path element

Static path element

Attributes

Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
trait PathDef
class Object
trait Matchable
class Any
final case class PathExp(names: List[String]) extends PathDef

Path segments, slash-prefixed (Section 3.2.6)

Path segments, slash-prefixed (Section 3.2.6)

Attributes

Companion:
object
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
trait PathDef
class Object
trait Matchable
class Any
object PathExp

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
PathExp.type
sealed trait QueryDef

Attributes

Source:
UriTemplate.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
sealed trait QueryExp extends QueryDef

Attributes

Source:
UriTemplate.scala
Graph
Supertypes
trait QueryDef
class Object
trait Matchable
class Any
Known subtypes
final case class ReservedExp(names: List[String]) extends PathDef

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)

Attributes

Companion:
object
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
trait PathDef
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class SimpleFragmentExp(name: String) extends FragmentDef

Fragment expansion, crosshatch-prefixed (Section 3.2.4)

Fragment expansion, crosshatch-prefixed (Section 3.2.4)

Attributes

Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class VarExp(names: List[String]) extends PathDef

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)

Attributes

Companion:
object
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Equals
trait PathDef
class Object
trait Matchable
class Any
object VarExp

Attributes

Companion:
class
Source:
UriTemplate.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
VarExp.type

Types

Attributes

Source:
UriTemplate.scala
type Path = List[PathDef]

Attributes

Source:
UriTemplate.scala

Attributes

Source:
UriTemplate.scala

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
Source:
Mirror.scala

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source:
Mirror.scala

Value members

Concrete methods