p

uritemplate4s

package uritemplate4s

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. uritemplate4s
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package syntax

Type Members

  1. final case class AssociativeArray(value: Seq[(String, String)]) extends Value with Product with Serializable

    Name value pairs for template substitution.

  2. final case class ComponentsUriTemplate(components: List[Component]) extends UriTemplate with Product with Serializable
  3. sealed abstract class Error extends Exception

    Base error type.

  4. sealed abstract class ExpandFailure extends Error

    Error when a UriTemplate is expanded.

  5. final case class ExpandFailures(errors: List[ExpandFailure]) extends ExpandFailure with Product with Serializable
  6. sealed trait ExpandResult extends AnyRef

    A successfully parsed uri template can always be expanded, but there might be some warnings associated.

  7. final case class InvalidCombinationFailure(message: String) extends ExpandFailure with Product with Serializable

    Error when the value supplied for substitution is not supported.

  8. final case class ListValue(value: Seq[String]) extends Value with Product with Serializable

    A list of values for template substitution.

  9. final case class MissingValueFailure(varname: String) extends ExpandFailure with Product with Serializable

    Error when a value has not been supplied for the template variable.

    Error when a value has not been supplied for the template variable.

    >>> uritemplate"http://{missingval}.com{/present}".expand("present" -> "foo").toEither
    Left(uritemplate4s.MissingValueFailure: missingval wasn't supplied as a variable value)
  10. final case class ParseFailure(index: Int, message: String) extends Error with Product with Serializable

    Error when parsing a UriTemplate.

    Error when parsing a UriTemplate.

    index

    the index where parsing failed.

    message

    error message.

  11. final case class StringValue(value: String) extends Value with Product with Serializable

    A single string value for template substitution.

  12. trait ToStringValue[A] extends ToValue[A]

    Type class that provides a conversion from A to String.

    Type class that provides a conversion from A to String. This is used to define a specific type class for strings, to be used for the elements of ListValue and the values of AssociativeArray.

  13. trait ToValue[A] extends AnyRef

    Type class that provides a conversion from A to Value.

    Type class that provides a conversion from A to Value.

    Annotations
    @implicitNotFound("No Argument instance found for ${A}. For more info, see: https://slakah.github.io/uritemplate4s/tovalue.html")
  14. trait UriTemplate extends UriTemplateBase with UriTemplateArities
  15. final class UriTemplateLiteralMacros extends AnyRef
  16. implicit final class UriTemplateStringContext extends AnyRef

    Parse and validate a Uri Template at compile time.

    Parse and validate a Uri Template at compile time.

    >>> Right(uritemplate"http://{name}.com") == UriTemplate.parse("http://{name}.com")
    true
    
    >>> compileError("""uritemplate"http://{invalid" """).msg
    not a valid URI Template, Position 1:16, found ""
  17. sealed trait Value extends AnyRef

    A value can be substituted in a template.

Value Members

  1. object ExpandResult
  2. object ToStringValue
  3. object ToValue
  4. object UriTemplate
  5. object ast

Inherited from AnyRef

Inherited from Any

Ungrouped