HttpResponseContext class

An implementation of ResponseContext that abstracts over an HttpResponse.

Inheritance

Constructors

HttpResponseContext(HttpResponse rawResponse, Angel? app, [HttpRequestContext? _correspondingRequest])

Properties

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

Methods

add(List<int> data) → void
Adds a data event to the sink.
override
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
Prevents more data from being written to the response, and locks it entire from further editing.
override
detach() HttpResponse
Signals Angel that the response is being held alive deliberately, and that the framework should not automatically close it.
override
download(File file, {String? filename}) Future<void>
Sends a download as a response.
inherited
json(dynamic value) Future<bool>
Serializes JSON to the response.
inherited
jsonp(dynamic value, {String callbackName = 'callback', MediaType? contentType}) Future<void>
Returns a JSONP response.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
redirect(dynamic url, {bool absolute = true, int? code}) Future<void>
Redirects to user to the given URL.
inherited
redirectTo(String name, [Map? params, int? code]) Future<void>
Redirects to the given named Route.
inherited
redirectToAction(String action, [Map? params, int? code]) Future<void>
Redirects to the given Controller action.
inherited
render(String view, [Map<String, dynamic>? data]) Future<void>
Renders a view to the response stream, and closes the response.
inherited
serialize(dynamic value, {MediaType? contentType}) Future<bool>
Serializes data to the response.
inherited
streamFile(File file) Future
Streams a file to this response.
inherited
toString() String
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.
override
write(Object? value, {Encoding? encoding}) → void
Writes data to the response.
inherited
writeAll(Iterable objects, [String separator = '']) → void
Writes the elements of objects separated by separator.
inherited
writeCharCode(int charCode) → void
Writes a string containing the character with code point charCode.
inherited
writeln([Object? obj = '']) → void
Writes the string representation of object followed by a newline.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited