core
0.23.19
API
Generated with
core/org.http4s/UriTemplate

UriTemplate

org.http4s.UriTemplate
See theUriTemplate companion object
final case class UriTemplate(scheme: Option[Scheme], authority: Option[Authority], path: Path, query: Query, fragment: Fragment)

Simple representation of a URI Template that can be rendered as RFC6570 conform string.

This model reflects only a subset of RFC6570.

Level 1 and Level 2 are completely modeled and Level 3 features are limited to:

  • Path segments, slash-prefixed
  • Form-style query, ampersand-separated
  • Fragment expansion

Attributes

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

Members list

Concise view

Value members

Concrete methods

def expandAny[T : QueryParamEncoder](name: String, value: T): UriTemplate

Replaces any expansion type that matches the given name. If no matching expansion could be found the same instance will be returned.

Replaces any expansion type that matches the given name. If no matching expansion could be found the same instance will be returned.

Attributes

Source:
UriTemplate.scala
def expandFragment[T : QueryParamEncoder](name: String, value: T): UriTemplate

Replaces any expansion type in fragment that matches the given name. If no matching expansion could be found the same instance will be returned.

Replaces any expansion type in fragment that matches the given name. If no matching expansion could be found the same instance will be returned.

Attributes

Source:
UriTemplate.scala
def expandPath[T : QueryParamEncoder](name: String, values: List[T]): UriTemplate

Replaces any expansion type in path that matches the given name. If no matching expansion could be found the same instance will be returned.

Replaces any expansion type in path that matches the given name. If no matching expansion could be found the same instance will be returned.

Attributes

Source:
UriTemplate.scala
def expandPath[T : QueryParamEncoder](name: String, value: T): UriTemplate

Replaces any expansion type in path that matches the given name. If no matching expansion could be found the same instance will be returned.

Replaces any expansion type in path that matches the given name. If no matching expansion could be found the same instance will be returned.

Attributes

Source:
UriTemplate.scala
def expandQuery[T : QueryParamEncoder](name: String, values: List[T]): UriTemplate

Replaces any expansion type in query that matches the specified name. If no matching expansion could be found the same instance will be returned.

Replaces any expansion type in query that matches the specified name. If no matching expansion could be found the same instance will be returned.

Attributes

Source:
UriTemplate.scala
def expandQuery(name: String): UriTemplate

Replaces any expansion type in query that matches the specified name. If no matching expansion could be found the same instance will be returned.

Replaces any expansion type in query that matches the specified name. If no matching expansion could be found the same instance will be returned.

Attributes

Source:
UriTemplate.scala
def expandQuery[T : QueryParamEncoder](name: String, values: T*): UriTemplate

Replaces any expansion type in query that matches the specified name. If no matching expansion could be found the same instance will be returned.

Replaces any expansion type in query that matches the specified name. If no matching expansion could be found the same instance will be returned.

Attributes

Source:
UriTemplate.scala
def toUriIfPossible: Try[Uri]

If no expansion is available an Uri will be created otherwise the current instance of UriTemplate will be returned.

If no expansion is available an Uri will be created otherwise the current instance of UriTemplate will be returned.

Attributes

Source:
UriTemplate.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

lazy override val toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Source:
UriTemplate.scala
Generated with