HTTP response for a client connection.
The body of an HttpClientResponse object is a Stream of data from the server. Use Stream methods like Stream.transform and Stream.join to access the data.
var client = HttpClient();
try {
HttpClientRequest request = await client.get('localhost', 80, '/file.txt');
HttpClientResponse response = await request.close();
final stringData = await response.transform(utf8.decoder).join();
print(stringData);
} finally {
client.close();
}
Properties
- certificate → X509Certificate?
-
Returns the certificate of the HTTPS server providing the response.
Returns null if the connection is not a secure TLS or SSL connection.
no setter
- compressionState → HttpClientResponseCompressionState
-
The compression state of the response.
no setter
- connectionInfo → HttpConnectionInfo?
-
Gets information about the client connection. Returns
null
if the socket is not available.no setter - contentLength → int
-
Returns the content length of the response body. Returns -1 if the size of
the response body is not known in advance.
no setter
-
Cookies set by the server (from the 'set-cookie' header).
no setter
-
first
→ Future<
List< int> > -
The first element of this stream.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- headers → HttpHeaders
-
Returns the client response headers.
no setter
- isBroadcast → bool
-
Whether this stream is a broadcast stream.
no setterinherited
-
isEmpty
→ Future<
bool> -
Whether this stream contains any elements.
no setterinherited
- isRedirect → bool
-
Returns whether the status code is one of the normal redirect
codes HttpStatus.movedPermanently, HttpStatus.found,
HttpStatus.movedTemporarily, HttpStatus.seeOther and
HttpStatus.temporaryRedirect.
no setter
-
last
→ Future<
List< int> > -
The last element of this stream.
no setterinherited
-
length
→ Future<
int> -
The number of elements in this stream.
no setterinherited
- persistentConnection → bool
-
Gets the persistent connection state returned by the server.
no setter
- reasonPhrase → String
-
Returns the reason phrase associated with the status code.
no setter
-
redirects
→ List<
RedirectInfo> -
Returns the series of redirects this connection has been through. The
list will be empty if no redirects were followed. redirects will be
updated both in the case of an automatic and a manual redirect.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
single
→ Future<
List< int> > -
The single element of this stream.
no setterinherited
- statusCode → int
-
Returns the status code.
no setter
Methods
-
any(
bool test(List< int> element)) → Future<bool> -
Checks whether
test
accepts any element provided by this stream.inherited -
asBroadcastStream(
{void onListen(StreamSubscription< List< subscription)?, void onCancel(StreamSubscription<int> >List< subscription)?}) → Stream<int> >List< int> > -
Returns a multi-subscription stream that produces the same events as this.
inherited
-
asyncExpand<
E> (Stream< E> ? convert(List<int> event)) → Stream<E> -
Transforms each element into a sequence of asynchronous events.
inherited
-
asyncMap<
E> (FutureOr< E> convert(List<int> event)) → Stream<E> -
Creates a new stream with each data event of this stream asynchronously
mapped to a new event.
inherited
-
cast<
R> () → Stream< R> -
Adapt this stream to be a
Stream<R>
.inherited -
contains(
Object? needle) → Future< bool> -
Returns whether
needle
occurs in the elements provided by this stream.inherited -
detachSocket(
) → Future< Socket> - Detach the underlying socket from the HTTP client. When the socket is detached the HTTP client will no longer perform any operations on it.
-
distinct(
[bool equals(List< int> previous, List<int> next)?]) → Stream<List< int> > -
Skips data events if they are equal to the previous data event.
inherited
-
drain<
E> ([E? futureValue]) → Future< E> -
Discards all data on this stream, but signals when it is done or an error
occurred.
inherited
-
elementAt(
int index) → Future< List< int> > -
Returns the value of the
index
th data event of this stream.inherited -
every(
bool test(List< int> element)) → Future<bool> -
Checks whether
test
accepts all elements provided by this stream.inherited -
expand<
S> (Iterable< S> convert(List<int> element)) → Stream<S> -
Transforms each element of this stream into a sequence of elements.
inherited
-
firstWhere(
bool test(List< int> element), {List<int> orElse()?}) → Future<List< int> > -
Finds the first element of this stream matching
test
.inherited -
fold<
S> (S initialValue, S combine(S previous, List< int> element)) → Future<S> -
Combines a sequence of values by repeatedly applying
combine
.inherited -
forEach(
void action(List< int> element)) → Future<void> -
Executes
action
on each element of this stream.inherited -
handleError(
Function onError, {bool test(dynamic error)?}) → Stream< List< int> > -
Creates a wrapper Stream that intercepts some errors from this stream.
inherited
-
join(
[String separator = ""]) → Future< String> -
Combines the string representation of elements into a single string.
inherited
-
lastWhere(
bool test(List< int> element), {List<int> orElse()?}) → Future<List< int> > -
Finds the last element in this stream matching
test
.inherited -
listen(
void onData(List< int> event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<List< int> > -
Adds a subscription to this stream.
inherited
-
map<
S> (S convert(List< int> event)) → Stream<S> -
Transforms each element of this stream into a new stream event.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pipe(
StreamConsumer< List< streamConsumer) → Futureint> > -
Pipes the events of this stream into
streamConsumer
.inherited -
redirect(
[String? method, Uri? url, bool? followLoops]) → Future< HttpClientResponse> -
Redirects this connection to a new URL. The default value for
method
is the method for the current request. The default value forurl
is the value of the HttpHeaders.locationHeader header of the current response. All body data must have been read from the current response before calling redirect. -
reduce(
List< int> combine(List<int> previous, List<int> element)) → Future<List< int> > -
Combines a sequence of values by repeatedly applying
combine
.inherited -
singleWhere(
bool test(List< int> element), {List<int> orElse()?}) → Future<List< int> > -
Finds the single element in this stream matching
test
.inherited -
skip(
int count) → Stream< List< int> > -
Skips the first
count
data events from this stream.inherited -
skipWhile(
bool test(List< int> element)) → Stream<List< int> > -
Skip data events from this stream while they are matched by
test
.inherited -
take(
int count) → Stream< List< int> > -
Provides at most the first
count
data events of this stream.inherited -
takeWhile(
bool test(List< int> element)) → Stream<List< int> > -
Forwards data events while
test
is successful.inherited -
timeout(
Duration timeLimit, {void onTimeout(EventSink< List< sink)?}) → Stream<int> >List< int> > -
Creates a new stream with the same events as this stream.
inherited
-
toList(
) → Future< List< List< >int> > -
Collects all elements of this stream in a List.
inherited
-
toSet(
) → Future< Set< List< >int> > -
Collects the data of this stream in a Set.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
transform<
S> (StreamTransformer< List< streamTransformer) → Stream<int> , S>S> -
Applies
streamTransformer
to this stream.inherited -
where(
bool test(List< int> event)) → Stream<List< int> > -
Creates a new stream from this stream that discards some elements.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited