class Athena::Routing::StreamedResponse

• Athena::Routing::StreamedResponse
• Athena::Routing::Response
• Reference
• Object

Overview

Represents an ART::Response whose content should be streamed to the client as opposed to being written all at once. This can be useful in cases where the response content is too large to fit into memory.

The content is stored in a proc that gets called when self is being written to the response IO. How the output gets written can be customized via an ART::Response::Writer.

Defined in:

Constructors

• .new(status : HTTP::Status | Int32 = HTTP::Status::OK, headers : HTTP::Headers = HTTP::Headers.new, &block : IO -> Nil)

  Creates a new response with optional status, and headers arguments.

• .new(callback : Proc(IO, Nil), status : HTTP::Status | Int32 = HTTP::Status::OK, headers : HTTP::Headers = HTTP::Headers.new)

  Creates a new response with the provided callback and optional status, and headers arguments.

Instance Method Summary

• #content=(callback : Proc(IO, Nil))

  Updates the callback of self.

• #write(output : IO) : Nil

  Streams the data in the stored Proc to the provided output.

Constructor Detail

require "athena"

class ExampleController < ART::Controller
  @[ART::Get("/users")]
  def users : ART::Response
    ART::StreamedResponse.new headers: HTTP::Headers{"content-type" => "application/json; charset=UTF-8"} do |io|
      User.all.to_json io
    end
  end
end

ART.run

# GET /users # => [{"id":1,...},...]

Instance Method Detail