final class PathBuilder[F[_], T <: HList] extends RouteExecutable[F, T] with Decodable[F, T, Nothing] with HeaderAppendable[F, T] with RoutePrependable[F, PathBuilder[F, T]] with UriConvertible[F]
Fully functional path building
- Alphabetic
- By Inheritance
- PathBuilder
- RoutePrependable
- HeaderAppendable
- Decodable
- RouteExecutable
- TypedBuilder
- UriConvertible
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type HeaderAppendResult[T <: HList] = Router[F, T]
- Definition Classes
- PathBuilder → HeaderAppendable
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +?[T1 <: HList](query: TypedQuery[F, T1])(implicit prep: Prepend[T1, T]): QueryBuilder[F, Out]
Capture a query rule
Capture a query rule
- T1
types of elements captured by query
- query
Query capture rule
- returns
a QueryBuilder with which to continue building the route
- def /[T2 <: HList](builder: RequestLineBuilder[F, T2])(implicit prep: Prepend[T2, T]): QueryBuilder[F, Out]
Append the path and rules
Append the path and rules
- builder
RequestLineBuilder rules to append to the path capture rules.
- returns
a new QueryBuilder that will execute the appended rules.
- def /[T2 <: HList](rules: TypedPath[F, T2])(implicit prep: Prepend[T2, T]): PathBuilder[F, Out]
Append the path rules to the PathBuilder
Append the path rules to the PathBuilder
- rules
TypedPath rules to append to the path capture rules.
- returns
a new PathBuilder that will execute the appended rules.
- def /(symbol: Symbol): PathBuilder[F, ::[String, T]]
Capture a
Stringfrom the pathCapture a
Stringfrom the path- symbol
Symbolrepresenting the name of the segment to capture.- returns
a new PathBuilder that will capture a uri segment.
- def /(segment: String): PathBuilder[F, T]
Match against a
StringMatch against a
String- segment
Stringto match against.- returns
a new PathBuilder that will match against the provided
String.
- def /(tail: CaptureTail.type): Router[F, ::[List[String], T]]
Capture the remaining elements in the path
Capture the remaining elements in the path
- returns
a Router
- def /:(prefix: TypedPath[F, HNil]): PathBuilder[F, T]
Prepend the prefix to the path rules
Prepend the prefix to the path rules
- prefix
non-capturing prefix to prepend
- returns
builder with the prefix prepended to the path rules
- Definition Classes
- PathBuilder → RoutePrependable
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def >>>[T1 <: HList](h2: TypedHeader[F, T1])(implicit prep: Prepend[T1, T]): Router[F, Out]
Append the header to the builder, generating a new typed representation of the route
Append the header to the builder, generating a new typed representation of the route
- Definition Classes
- PathBuilder → HeaderAppendable
- final def ^[R2 >: Nothing](decoder: EntityDecoder[F, R2])(implicit F: Functor[F], t: scala.reflect.api.JavaUniverse.TypeTag[R2]): CodecRouter[F, T, R2]
Decode the body using the
EntityDecoderDecode the body using the
EntityDecoderAlias for decoding
- R2
type of the result.
- decoder
EntityDecoderto utilize for decoding the body.
- Definition Classes
- Decodable
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asUri(request: Request[F]): Try[Uri]
Converts a route into an
Uri.Converts a route into an
Uri.If the conversion fails
Noneis returned. In case your route has multiple paths only one way will be resolved as instance ofUri. If the route is a URI Template but not an URINonewill be returned.- Definition Classes
- UriConvertible
- final def asUriTemplate(request: Request[F]): Try[UriTemplate]
Converts a route into an
UriTemplate.Converts a route into an
UriTemplate.If the conversion fails
Noneis returned. In case your route has multiple paths only one way will be resolved as instance ofUriTemplate.- Definition Classes
- TypedBuilder → UriConvertible
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def decoding[R](decoder: EntityDecoder[F, R])(implicit F: Functor[F], t: scala.reflect.api.JavaUniverse.TypeTag[R]): CodecRouter[F, T, R]
Decode the body using the
EntityDecoderDecode the body using the
EntityDecoderAlias for the
^operator.- decoder
EntityDecoderto utilize for decoding the body.
- Definition Classes
- PathBuilder → Decodable
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def makeRoute(action: Action[F, T]): RhoRoute[F, T]
Create a RhoRoute from a given Action
- Definition Classes
- PathBuilder → RouteExecutable
- val method: Method
Methodof the incoming HTTPRequestMethodof the incoming HTTPRequest- Definition Classes
- PathBuilder → RouteExecutable
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val path: PathRule
Untyped AST representation of the path to operate on
Untyped AST representation of the path to operate on
- Definition Classes
- PathBuilder → TypedBuilder
- val rules: RequestRule[F]
Untyped AST describing the extraction of headers and the query from the
RequestUntyped AST describing the extraction of headers and the query from the
Request- Definition Classes
- PathBuilder → TypedBuilder
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def validate[T1 <: HList](header: TypedHeader[F, T1])(implicit prep: Prepend[T1, T]): HeaderAppendResult[Out]
Append the header to the builder, generating a new typed representation of the route
Append the header to the builder, generating a new typed representation of the route
- Definition Classes
- HeaderAppendable
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def |>>[U, R](f: U)(implicit hltf: HListToFunc[F, T, U], srvc: CompileRoutes[F, R]): R
Compiles a HTTP request definition into an action
Compiles a HTTP request definition into an action
- Definition Classes
- RouteExecutable
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.