ResponseContext<RawResponse> class

A convenience wrapper around an outgoing HTTP request.

Implemented types
  • StreamConsumer<List<int>>
  • StreamSink<List<int>>
  • StringSink
Implementers

Constructors

ResponseContext()

Properties

app ↔ Angel
The Angel instance that is sending a response.
read / write
buffer → BytesBuilder
A set of UTF-8 encoded bytes that will be written to the response.
read-only
chunked ↔ bool
Is Transfer-Encoding chunked?
read / write
contentLength ↔ int
Gets or sets the content length to send back to a client. [...]
read / write
contentType ↔ MediaType
Gets or sets the content type to send back to a client.
read / write
cookies → List<Cookie>
Any and all cookies to be sent to the user.
final
correspondingRequest → RequestContext
Points to the RequestContext corresponding to this response.
read-only
done → Future
Return a future which is completed when the StreamSink is finished. [...]
read-only, override
encoders → Map<String, Converter<List<int>, List<int>>>
A set of Converter objects that can be used to encode response data. [...]
final
hashCode → int
The hash code for this object. [...]
read-only, inherited
headers → CaseInsensitiveMap<String>
Headers that will be sent to the user. [...]
read-only
isBuffered → bool
Returns true if response data is being written to a buffer, rather than to the underlying stream.
read-only
isOpen → bool
Returns true if the response is still available for processing by Angel. [...]
read-only
properties → Map
final
rawResponse → RawResponse
The underlying RawResponse under this instance.
read-only
renderParams → Map<String, dynamic>
A Map of data to inject when res.render is called. [...]
final
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
serializer ↔ FutureOr<String> Function(dynamic)
Serializes response data into a String. [...]
read / write
statusCode ↔ int
This response's status code.
read / write

Methods

add(List<int> event) → void
Adds a data event to the sink. [...]
inherited
addError(Object error, [StackTrace stackTrace]) → void
Adds an error to the sink. [...]
override
addStream(Stream<List<int>> stream) → Future
Adds a stream directly the underlying response. [...]
override
close() → Future<void>
Prevents more data from being written to the response, and locks it entire from further editing.
override
detach() → FutureOr<RawResponse>
Signals Angel that the response is being held alive deliberately, and that the framework should not automatically close it. [...]
download(File file, {String filename}) → Future<void>
Sends a download as a response.
json(dynamic value) → void
Serializes JSON to the response.
jsonp(dynamic value, {String callbackName = "callback", MediaType contentType}) → Future<void>
Returns a JSONP response. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
redirect(dynamic url, {bool absolute = true, int code = 302}) → Future<void>
Redirects to user to the given URL. [...]
redirectTo(String name, [Map params, int code]) → Future<void>
Redirects to the given named Route.
redirectToAction(String action, [Map params, int code]) → Future<void>
Redirects to the given Controller action.
render(String view, [Map<String, dynamic> data]) → Future<void>
Renders a view to the response stream, and closes the response.
serialize(dynamic value, {MediaType contentType}) → Future<bool>
Serializes data to the response.
streamFile(File file) → Future
Streams a file to this response. [...]
toString() → String
Returns a string representation of this object.
inherited
useBuffer() → void
Configure the response to write to an intermediate response buffer, rather than to the stream directly.
write(Object value, {Encoding encoding}) → void
Writes data to the response.
override
writeAll(Iterable objects, [String separator = ""]) → void
Iterates over the given objects and writes them in sequence.
override
writeCharCode(int charCode) → void
Writes the charCode to this. [...]
override
writeln([Object obj = ""]) → void
Converts obj to a String by invoking Object.toString and adds the result to this, followed by a newline.
override

Operators

operator ==(Object other) → bool
The equality operator. [...]
inherited

Static Methods

closed() → StateError