Class

org.http4s.rho.bits.PathAST

TypedPath

Related Doc: package PathAST

Permalink

case class TypedPath[F[_], T <: HList](rule: PathRule) extends UriConvertible[F] with Product with Serializable

Typed shell for the Path operations of the DSL

Linear Supertypes
Serializable, Serializable, Product, Equals, UriConvertible[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TypedPath
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. UriConvertible
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TypedPath(rule: PathRule)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def &&[T2 <: HList](p2: TypedPath[F, T2])(implicit prep: Prepend[T2, T]): TypedPath[F, Out]

    Permalink

    Match this rule and then next rule

    Match this rule and then next rule

    Alias of and

  4. def +?[T1 <: HList](query: TypedQuery[F, T1])(implicit prep: Prepend[T1, T]): RequestLineBuilder[F, Out]

    Permalink

    Capture a query rule

    Capture a query rule

    T1

    The types of elements captured by query.

    query

    Query capture rule

    returns

    A QueryBuilder with which to continue building the route.

  5. def /[T2 <: HList](builder: RequestLineBuilder[F, T2])(implicit prep: Prepend[T, T2]): RequestLineBuilder[F, Out]

    Permalink

    Prepend this path rule to the RequestLineBuilder

    Prepend this path rule to the RequestLineBuilder

    builder

    RequestLineBuilder rules to append to the path capture rules.

    returns

    a new RequestLineBuilder with this rule prepended.

  6. def /[T2 <: HList](rules: TypedPath[F, T2])(implicit prep: Prepend[T2, T]): TypedPath[F, Out]

    Permalink

    Append the path rules to the TypedPath

    Append the path rules to the TypedPath

    rules

    TypedPath rules to append to the path capture rules.

    returns

    a new TypedPath that will execute the appended rules.

  7. def /(symbol: Symbol): TypedPath[F, ::[String, T]]

    Permalink

    Capture a String from the path

    Capture a String from the path

    symbol

    Symbol representing the name of the segment to capture.

    returns

    a new TypedPath that will capture a uri segment.

  8. def /(segment: String): TypedPath[F, T]

    Permalink

    Match against a String

    Match against a String

    segment

    String to match against.

    returns

    a new TypedPath that will match against the provided String.

  9. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def and[T2 <: HList](next: TypedPath[F, T2])(implicit prep: Prepend[T2, T]): TypedPath[F, Out]

    Permalink

    Match this rule and then next rule

    Match this rule and then next rule

    Alias of &&

  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def asUri(request: Request[F]): Try[Uri]

    Permalink

    Converts a route into an Uri.

    Converts a route into an Uri.

    If the conversion fails None is returned. In case your route has multiple paths only one way will be resolved as instance of Uri. If the route is a URI Template but not an URI None will be returned.

    Definition Classes
    UriConvertible
  13. def asUriTemplate(request: Request[F]): Try[UriTemplate]

    Permalink

    Converts a route into an UriTemplate.

    Converts a route into an UriTemplate.

    If the conversion fails None is returned. In case your route has multiple paths only one way will be resolved as instance of UriTemplate.

    Definition Classes
    TypedPathUriConvertible
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. def or(alt: TypedPath[F, T]): TypedPath[F, T]

    Permalink

    Match this rule or alt rule if this rule fails

    Match this rule or alt rule if this rule fails

    Alias of ||

  23. val rule: PathRule

    Permalink
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def ||(alt: TypedPath[F, T]): TypedPath[F, T]

    Permalink

    Match this rule or alt rule if this rule fails

    Match this rule or alt rule if this rule fails

    Alias of or

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from UriConvertible[F]

Inherited from AnyRef

Inherited from Any

Ungrouped