Response

Type Members

final case class PathResponse extends Response with Product with Serializable
class PermanentCache extends PartialFunction[Request, IO[HTTPError, Response]]

A cache that memoizes responses for eligible requests, and can cache response bodies of eligible responses
final case class WebsocketResponse extends Response with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object PermanentCache
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def const(body: Array[Byte], status: Status = Status.Ok, contentType: String = "application/octet-stream", headers: List[(String, String)] = Nil): Response
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] )
def fromInputStream(stream: ZManaged[Blocking, Throwable, InputStream], size: Long, contentType: String = "application/octet-stream", status: Status = Status.Ok, headers: List[(String, String)] = Nil): UIO[Response]
def fromPath(path: Path, request: Request, contentType: String = "application/octet-stream", status: Status = Status.Ok, headers: List[(String, String)] = Nil): ZIO[Blocking, Throwable, Response]

Read a response from a path.
Read a response from a path. Uses blocking I/O, so that a file on the local filesystem can be directly transferred to the connection using OS-level primitives when possible.
Note that you mustn't use this method if the response may be cached, as (depending on the request) it may produce a 304 Not Modified response. You don't want that being served to other clients! Use
path
A Path pointing to the file on the filesystem.
request
The request to respond to. This is used:
- To check if the If-Modified-Since header value included in the request for this file. If given (in RFC 1123 format), an attempt will be made to determine if the file has been modified since the requested timestamp. If it hasn't, then the response returned will be a 304 Not Modified response with no body.
- To provide the URI for a NotFound error, in case the path does not exist.
contentType
The Content-Type header to use for the response. Defaults to application/octet-stream.
status
The status of the response. Defaults to Ok (HTTP 200)
headers
Any additional headers to include in the response.
returns
A ZIO value which, when evaluated, will attempt to locate the given resource and provide an appropriate Response. If the resource isn't present, it will fail with HTTPError.NotFound. Since this response interacts with the filesystem, it can fail with other arbitrary Throwable failures; you'll probably need to catch these and convert them to HTTPError failures.
def fromResource(name: String, request: Request, classLoader: ClassLoader = getClass.getClassLoader, contentType: String = "application/octet-stream", status: Status = Status.Ok, headers: List[(String, String)] = Nil): ZIO[Blocking, Throwable, Response]

Read a response from a resource.
Read a response from a resource. Uses blocking I/O, so that a file on the local filesystem can be directly transferred to the connection using OS-level primitives when possible.
name
The name (path) of the resource
request
The request to respond to. This is used:
- To check if the If-Modified-Since header value included in the request for this file. If given (in RFC 1123 format), an attempt will be made to determine if the file has been modified since the requested timestamp. If it hasn't, then the response returned will be a 304 Not Modified response with no body.
- To provide the URI for a NotFound error, in case the path does not exist.
classLoader
The class loader which can find the resource (defaults to this class's class loader)
contentType
The Content-Type header to use for the response. Defaults to application/octet-stream.
status
The status of the response. Defaults to Ok (HTTP 200)
headers
Any additional headers to include in the response.
returns
A ZIO value which, when evaluated, will attempt to locate the given resource and provide an appropriate Response. If the resource isn't present, it will fail with HTTPError.NotFound. Since this response interacts with the filesystem, it can fail with other arbitrary Throwable failures; you'll probably need to catch these and convert them to HTTPError failures.
def fromStream(stream: Stream[Nothing, Chunk[Byte]], size: Long, contentType: String = "application/octet-stream", status: Status = Status.Ok, ifModifiedSince: Option[String] = None, headers: List[(String, String)] = Nil): UIO[Response]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def html(body: String, status: Status = Status.Ok, headers: List[(String, String)] = Nil, charset: Charset = StandardCharsets.UTF_8): Response
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
lazy val notModified: Response
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def permanentCache: Builder[Blocking]

Build a caching layer which can memoize and cache responses in memory for the duration of the server's lifetime.
def plain(body: String, status: Status = Status.Ok, headers: List[(String, String)] = Nil, charset: Charset = StandardCharsets.UTF_8): Response
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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
@throws( ... )
def websocket(req: Request, output: Stream[Throwable, Frame], headers: List[(String, String)] = Nil): IO[BadRequest, WebsocketResponse]

Start a websocket request from a stream of uzhttp.websocket.Frames.
Start a websocket request from a stream of uzhttp.websocket.Frames.
req
The websocket request that initiated this response.
output
A stream of websocket uzhttp.websocket.Frames to be sent to the client.
headers
Any additional headers to include in the response.

Related Docs: trait Response | package uzhttp

object Response

Type Members

final case class PathResponse extends Response with Product with Serializable

class PermanentCache extends PartialFunction[Request, IO[HTTPError, Response]]

final case class WebsocketResponse extends Response with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object PermanentCache

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def const(body: Array[Byte], status: Status = Status.Ok, contentType: String = "application/octet-stream", headers: List[(String, String)] = Nil): Response

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fromInputStream(stream: ZManaged[Blocking, Throwable, InputStream], size: Long, contentType: String = "application/octet-stream", status: Status = Status.Ok, headers: List[(String, String)] = Nil): UIO[Response]

def fromPath(path: Path, request: Request, contentType: String = "application/octet-stream", status: Status = Status.Ok, headers: List[(String, String)] = Nil): ZIO[Blocking, Throwable, Response]

def fromResource(name: String, request: Request, classLoader: ClassLoader = getClass.getClassLoader, contentType: String = "application/octet-stream", status: Status = Status.Ok, headers: List[(String, String)] = Nil): ZIO[Blocking, Throwable, Response]

def fromStream(stream: Stream[Nothing, Chunk[Byte]], size: Long, contentType: String = "application/octet-stream", status: Status = Status.Ok, ifModifiedSince: Option[String] = None, headers: List[(String, String)] = Nil): UIO[Response]

final def getClass(): Class[_]

def hashCode(): Int

def html(body: String, status: Status = Status.Ok, headers: List[(String, String)] = Nil, charset: Charset = StandardCharsets.UTF_8): Response

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

lazy val notModified: Response

final def notify(): Unit

final def notifyAll(): Unit

def permanentCache: Builder[Blocking]

def plain(body: String, status: Status = Status.Ok, headers: List[(String, String)] = Nil, charset: Charset = StandardCharsets.UTF_8): Response

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def websocket(req: Request, output: Stream[Throwable, Frame], headers: List[(String, String)] = Nil): IO[BadRequest, WebsocketResponse]

Inherited from AnyRef

Inherited from Any

Ungrouped