sealed trait Output[+A] extends AnyRef
- Alphabetic
- By Inheritance
- Output
- AnyRef
- Any
- by OutputOps
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
charset: Option[Charset]
The charset of this Output.
-
abstract
def
cookies: Seq[Cookie]
The cookie list of this Output.
-
abstract
def
copy(status: Status = self.status, charset: Option[Charset] = self.charset, headers: Map[String, String] = self.headers, cookies: Seq[Cookie] = self.cookies): Output[A]
- Attributes
- protected
-
abstract
def
headers: Map[String, String]
The header map of this Output.
-
abstract
def
status: Status
The status code of this Output.
-
abstract
def
value: A
Returns the payload value of this Output or throws an exception.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Output[A], B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- def ensuring(cond: (Output[A]) ⇒ Boolean, msg: ⇒ Any): Output[A]
- def ensuring(cond: (Output[A]) ⇒ Boolean): Output[A]
- def ensuring(cond: Boolean, msg: ⇒ Any): Output[A]
- def ensuring(cond: Boolean): Output[A]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- final def flatMap[B](fn: (A) ⇒ Output[B]): Output[B]
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def map[B](fn: (A) ⇒ B): Output[B]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
o: Output[A]
- Implicit
- This member is added by an implicit conversion from Output[A] to OutputOps[A] performed by method OutputOps in io.finch.Output.
- Definition Classes
- OutputOps
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toResponse[CT](implicit tr: ToResponse.Aux[A, CT], tre: ToResponse.Aux[Exception, CT]): Response
Converts this Output to the HTTP response of the given
version
.Converts this Output to the HTTP response of the given
version
.- Implicit
- This member is added by an implicit conversion from Output[A] to OutputOps[A] performed by method OutputOps in io.finch.Output.
- Definition Classes
- OutputOps
-
def
toString(): String
- Definition Classes
- AnyRef → Any
- final def traverse[B](fn: (A) ⇒ Future[B]): Future[Output[B]]
- final def traverseFlatten[B](fn: (A) ⇒ Future[Output[B]]): Future[Output[B]]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
withCharset(charset: Charset): Output[A]
Overrides
charset
of this Output. -
final
def
withCookie(cookie: Cookie): Output[A]
Adds a given
cookie
to this Output. -
final
def
withCookies(cookies: Seq[Cookie]): Output[A]
Adds given
cookies
to this Output. -
final
def
withHeader(header: (String, String)): Output[A]
Adds a given
header
to this Output. -
final
def
withHeaders(headers: Map[String, String]): Output[A]
Adds given
headers
to this Output. -
final
def
withStatus(status: Status): Output[A]
Overrides the
status
code of this Output. - def →[B](y: B): (Output[A], B)
This is the API documentation for finch
Finch is a thin layer of purely functional basic blocks atop of [Finagle][finagle] for building composable HTTP APIs. Its mission is to provide the developers simple and robust HTTP primitives being as close as possible to the bare metal Finagle API.
Finch uses multi-project structure and contains of the following _modules_:
Please refer to the documentation for a more detailed introduction to the library.