class Athena::Framework::Response
inherits Reference
#
Represents an HTTP response that should be returned to the client.
Contains the content, status, and headers that should be applied to the actual HTTP::Server::Response.
This type is used to allow the content, status, and headers to be mutated by ATH::Listeners before being returned to the client.
The #content is written all at once to the server response's IO.
Direct known subclasses
Athena::Framework::BinaryFileResponse
Athena::Framework::RedirectResponse
Athena::Framework::StreamedResponse
Constructors#
.new(content : String | Nil = nil, status : HTTP::Status | Int32 = HTTP::Status::OK, headers : HTTP::Headers | ATH::Response::Headers = ATH::Response::Headers.new)#
Creates a new response with optional content, status, and headers arguments.
Methods#
#last_modified : Time | ::Nil#
Returns a Timerepresenting the last-modified header if set, otherwise nil.
#last_modified=(time : Time | Nil = nil) : Nil#
Updates the last-modified header to the provided time.
Removes the header if time is nil.
#redirect?(location : String | Nil = nil) : Bool#
Returns true if this response is a redirect, optionally to the provided location.
Otherwise, returns false.
#send(request : ATH::Request, response : HTTP::Server::Response) : Nil#
Sends self to the client based on the provided context.
How the content gets written can be customized via an ATH::Response::Writer.
#set_etag(etag : String | Nil = nil, weak : Bool = false) : Nil#
Updates the etag header to the provided, optionally weak, etag.
Removes the header if etag is nil.
#set_public : Nil#
Marks self as "public".
Adds the public cache-control directive and removes the private directive.