Object

io.finch.Endpoints

string

Related Doc: package Endpoints

Permalink

object string extends StringExtractor

A matching Endpoint that reads a string value from the current path segment.

Linear Supertypes
StringExtractor, Serializable, Serializable, Product, Equals, Endpoint[String], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. string
  2. StringExtractor
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. Endpoint
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def /[B](that: Endpoint[B])(implicit pa: PairAdjoin[String, B]): Endpoint[internal.PairAdjoin.Out]

    Permalink

    Composes this endpoint with the given Endpoint.

    Composes this endpoint with the given Endpoint.

    Definition Classes
    Endpoint
  4. def :+:[B](that: Endpoint[B])(implicit adjoin: Adjoin[:+:[B, :+:[String, CNil]]]): Endpoint[shapeless.ops.adjoin.Adjoin.Out]

    Permalink

    Composes this endpoint with another in such a way that coproducts are flattened.

    Composes this endpoint with another in such a way that coproducts are flattened.

    Definition Classes
    Endpoint
  5. def ::[B](that: Endpoint[B])(implicit pa: PairAdjoin[B, String]): Endpoint[internal.PairAdjoin.Out]

    Permalink

    Composes this endpoint with the given Endpoint.

    Composes this endpoint with the given Endpoint.

    Definition Classes
    Endpoint
  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  7. def ?[B](that: Endpoint[B])(implicit pa: PairAdjoin[String, B]): Endpoint[internal.PairAdjoin.Out]

    Permalink

    Composes this endpoint with the given Endpoint.

    Composes this endpoint with the given Endpoint.

    Definition Classes
    Endpoint
  8. def adjoin[B](that: Endpoint[B])(implicit pa: PairAdjoin[String, B]): Endpoint[internal.PairAdjoin.Out]

    Permalink

    Composes this endpoint with the given that endpoint.

    Composes this endpoint with the given that endpoint. The resulting endpoint will succeed only if both this and that endpoints succeed.

    Definition Classes
    Endpoint
  9. def ap[B](fn: Endpoint[(String) ⇒ B]): Endpoint[B]

    Permalink

    Maps this endpoint to Endpoint[A => B].

    Maps this endpoint to Endpoint[A => B].

    Definition Classes
    Endpoint
  10. def apply(n: String): Endpoint[String]

    Permalink
    Definition Classes
    StringExtractor
  11. def apply(input: Input): Result[String]

    Permalink

    Runs this endpoint.

    Runs this endpoint.

    Definition Classes
    StringExtractor → Endpoint
  12. def apply(mapper: Mapper[String]): Endpoint[Out]

    Permalink

    Maps this endpoint to either A => Output[B] or A => Output[Future[B]].

    Maps this endpoint to either A => Output[B] or A => Output[Future[B]].

    Definition Classes
    Endpoint
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  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. def handle[B >: String](pf: PartialFunction[Throwable, Output[B]]): Endpoint[B]

    Permalink

    Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.

    Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.

    Definition Classes
    Endpoint
  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. def item: RequestItem

    Permalink
    Definition Classes
    Endpoint
  21. def lift: Endpoint[Option[String]]

    Permalink

    Lifts this endpoint into one that always succeeds, with an empty Option representing failure.

    Lifts this endpoint into one that always succeeds, with an empty Option representing failure.

    Definition Classes
    Endpoint
  22. def map[B](fn: (String) ⇒ B): Endpoint[B]

    Permalink

    Maps this endpoint to the given function A => B.

    Maps this endpoint to the given function A => B.

    Definition Classes
    Endpoint
  23. def mapAsync[B](fn: (String) ⇒ Future[B]): Endpoint[B]

    Permalink

    Maps this endpoint to the given function A => Future[B].

    Maps this endpoint to the given function A => Future[B].

    Definition Classes
    Endpoint
  24. def mapOutput[B](fn: (String) ⇒ Output[B]): Endpoint[B]

    Permalink

    Maps this endpoint to the given function A => Output[B].

    Maps this endpoint to the given function A => Output[B].

    Definition Classes
    Endpoint
  25. def mapOutputAsync[B](fn: (String) ⇒ Future[Output[B]]): Endpoint[B]

    Permalink

    Maps this endpoint to the given function A => Future[Output[B]].

    Maps this endpoint to the given function A => Future[Output[B]].

    Definition Classes
    Endpoint
  26. val name: String

    Permalink
    Definition Classes
    StringExtractor
  27. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  30. def rescue[B >: String](pf: PartialFunction[Throwable, Future[Output[B]]]): Endpoint[B]

    Permalink

    Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.

    Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.

    Definition Classes
    Endpoint
  31. def should(rule: ValidationRule[String]): Endpoint[String]

    Permalink

    Validates the result of this endpoint using a predefined rule.

    Validates the result of this endpoint using a predefined rule. This method allows for rules to be reused across multiple request readers.

    rule

    the predefined ValidationRule that will return true if the data is valid

    returns

    an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with an Error.NotValid error.

    Definition Classes
    Endpoint
  32. def should(rule: String)(predicate: (String) ⇒ Boolean): Endpoint[String]

    Permalink

    Validates the result of this endpoint using a predicate.

    Validates the result of this endpoint using a predicate. The rule is used for error reporting.

    rule

    text describing the rule being validated

    predicate

    returns true if the data is valid

    returns

    an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with an Error.NotValid error.

    Definition Classes
    Endpoint
  33. def shouldNot(rule: ValidationRule[String]): Endpoint[String]

    Permalink

    Validates the result of this endpoint using a predefined rule.

    Validates the result of this endpoint using a predefined rule. This method allows for rules to be reused across multiple request readers.

    rule

    the predefined ValidationRule that will return false if the data is valid

    returns

    an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with a Error.NotValid error.

    Definition Classes
    Endpoint
  34. def shouldNot(rule: String)(predicate: (String) ⇒ Boolean): Endpoint[String]

    Permalink

    Validates the result of this endpoint using a predicate.

    Validates the result of this endpoint using a predicate. The rule is used for error reporting.

    rule

    text describing the rule being validated

    predicate

    returns false if the data is valid

    returns

    an endplint that will return the value of this reader if it is valid. Otherwise the future fails with a Error.NotValid error.

    Definition Classes
    Endpoint
  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  36. def toService(implicit ts: ToService[String]): Service[Request, Response]

    Permalink

    Converts this endpoint to a Finagle service Request => Future[Response].

    Converts this endpoint to a Finagle service Request => Future[Response].

    Definition Classes
    Endpoint
  37. def toString(): String

    Permalink
    Definition Classes
    StringExtractor → AnyRef → Any
  38. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def withCharset(charset: Option[String]): Endpoint[String]

    Permalink
    Definition Classes
    Endpoint
  42. def withContentType(contentType: Option[String]): Endpoint[String]

    Permalink
    Definition Classes
    Endpoint
  43. def withCookie(cookie: Cookie): Endpoint[String]

    Permalink
    Definition Classes
    Endpoint
  44. def withFilter(p: (String) ⇒ Boolean): Endpoint[String]

    Permalink
    Definition Classes
    Endpoint
  45. def withHeader(header: (String, String)): Endpoint[String]

    Permalink
    Definition Classes
    Endpoint
  46. def |[B >: String](that: Endpoint[B]): Endpoint[B]

    Permalink

    Sequentially composes this endpoint with the given that endpoint.

    Sequentially composes this endpoint with the given that endpoint. The resulting endpoint will succeed if either this or that endpoints are succeed.

    Definition Classes
    Endpoint

Deprecated Value Members

  1. def embedFlatMap[B](fn: (String) ⇒ Future[B]): Endpoint[B]

    Permalink
    Definition Classes
    Endpoint
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) Use Endpoint.mapAsync instead

Inherited from StringExtractor

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Endpoint[String]

Inherited from AnyRef

Inherited from Any

Ungrouped