Skip to content

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, 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.

View source

Methods#

#charset #

Returns the character set this response is encoded as.

View source

#charset=(charset : String) #

Returns the character set this response is encoded as.

View source

#content #

Returns the contents of this response.

View source

#content=(content : String?) #

Sets the response content.

View source

#etag #

Returns the value of the etag header if set, otherwise nil.

View source

#headers #

Returns the response headers of this response.

View source

#last_modified #

Returns a Timerepresenting the last-modified header if set, otherwise nil.

View source

#last_modified=(time : Time? = nil) : Nil #

Updates the last-modified header to the provided time. Removes the header if time is nil.

View source

#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.

View source

#set_etag(etag : String? = nil, weak : Bool = false) : Nil #

Updates the etag header to the provided, optionally weak, etag. Removes the header if etag is nil.

View source

#set_public #

Marks self as "public".

Adds the public cache-control directive and removes the private directive.

View source

#status #

Returns the HTTP::Status of this response.

View source

#status=(code : HTTP::Status | Int32) : Nil #

Sets the HTTP::Status of this response.

View source