Class/Object

io.finch

EndpointResult

Related Docs: object EndpointResult | package finch

Permalink

sealed abstract class EndpointResult[+A] extends AnyRef

A result returned from an Endpoint. This models Option[(Input, Future[Output])] and represents two cases:

API methods exposed on this type are mostly introduced for testing.

This class also provides various of awaitX methods useful for testing and experimenting.

Linear Supertypes
AnyRef, Any
Known Subclasses
Matched, Skipped
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointResult
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def isMatched: Boolean

    Permalink

    Whether the Endpoint is matched on a given Input.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. final def awaitOutput(d: Duration = Duration.Top): Option[Try[Output[A]]]

    Permalink

    Awaits for an Output wrapped with Try (indicating if the com.twitter.util.Future is failed).

    Awaits for an Output wrapped with Try (indicating if the com.twitter.util.Future is failed).

    returns

    Some(output) if this endpoint was matched on a given input, None otherwise.

    Note

    This method is blocking. Never use it in production.

  6. final def awaitOutputUnsafe(d: Duration = Duration.Top): Option[Output[A]]

    Permalink

    Awaits an Output of the Endpoint result or throws an exception if an underlying com.twitter.util.Future is failed.

    Awaits an Output of the Endpoint result or throws an exception if an underlying com.twitter.util.Future is failed.

    returns

    Some(output) if this endpoint was matched on a given input, None otherwise.

    Note

    This method is blocking. Never use it in production.

  7. final def awaitValue(d: Duration = Duration.Top): Option[Try[A]]

    Permalink

    Awaits a value from the Output wrapped with Try (indicating if either the com.twitter.util.Future is failed or Output wasn't a payload).

    Awaits a value from the Output wrapped with Try (indicating if either the com.twitter.util.Future is failed or Output wasn't a payload).

    returns

    Some(value) if this endpoint was matched on a given input, None otherwise.

    Note

    This method is blocking. Never use it in production.

  8. final def awaitValueUnsafe(d: Duration = Duration.Top): Option[A]

    Permalink

    Awaits a value from the Output or throws an exception if either an underlying com.twitter.util.Future is failed or Output wasn't a payload.

    Awaits a value from the Output or throws an exception if either an underlying com.twitter.util.Future is failed or Output wasn't a payload.

    returns

    Some(value) if this endpoint was matched on a given input, None otherwise.

    Note

    @note This method is blocking. Never use it in production.

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def output: Option[Future[Output[A]]]

    Permalink

    Runs and returns the Output (wrapped with future) after an Endpoint is matched.

    Runs and returns the Output (wrapped with future) after an Endpoint is matched.

    returns

    Some(output) if this endpoint was matched on a given input, None otherwise.

  20. final def remainder: Option[Input]

    Permalink

    Returns the remainder of the Input after an Endpoint is matched.

    Returns the remainder of the Input after an Endpoint is matched.

    returns

    Some(remainder) if this endpoint was matched on a given input, None otherwise.

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

    Permalink
    Definition Classes
    AnyRef

  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped