Spec-Zone.ru › Dart 2

dart:io

Класс HttpClientRequest

HTTP-запрос для клиентского соединения.

Чтобы настроить запрос, задайте заголовки с помощью свойства headers этого класса и запишите данные в тело запроса. HttpClientRequest — это IOSink. Используйте методы IOSink, например writeCharCode(), чтобы записать тело HTTP-запроса. При первом вызове одного из методов IOSink отправляется заголовок запроса. Вызов методов, изменяющих заголовок после его отправки, приводит к исключению.

При записи строковых данных через IOSink используемая кодировка определяется параметром "charset" заголовка "Content-Type".

var client = HttpClient();
HttpClientRequest request = await client.get('localhost', 80, '/file.txt');
request.headers.contentType =
    ContentType('application', 'json', charset: 'utf-8');
request.write('text content👍🎯'); // Strings written will be UTF-8 encoded.

Если кодировка не указана, используется ISO-8859-1 (Latin 1) по умолчанию.

var client = HttpClient();
HttpClientRequest request = await client.get('localhost', 80, '/file.txt');
request.headers.add(HttpHeaders.contentTypeHeader, "text/plain");
request.write('blåbærgrød'); // Strings written will be ISO-8859-1 encoded

Если используется неподдерживаемая кодировка, а метод write() принимает строковый параметр, возникает исключение.

Реализуемые типы
  • IOSink

Конструкторы

HttpClientRequest()

Свойства

bufferOutput ↔ bool
чтение / запись
Возвращает или задаёт, должен ли HttpClientRequest буферизовать вывод.
connectionInfo → HttpConnectionInfo?
только чтение
Возвращает информацию о клиентском соединении.
contentLength ↔ int
чтение / запись
Возвращает и задаёт длину содержимого запроса.
cookies → List<Cookie>
только чтение
Файлы cookie, передаваемые серверу (в заголовке 'cookie').
done → Future<HttpClientResponse>
только чтениепереопределено
Асинхронный HttpClientResponse future, который завершится, когда ответ станет доступен.
encoding ↔ Encoding
чтение / записьунаследовано
Encoding, используемая при записи строк.
followRedirects ↔ bool
чтение / запись
Нужно ли автоматически следовать перенаправлениям.
hashCode → int
только чтениеунаследовано
Хеш-код этого объекта.
headers → HttpHeaders
только чтение
Возвращает заголовки клиентского запроса.
maxRedirects ↔ int
чтение / запись
Задаёт максимальное количество перенаправлений, за которыми следует переходить, если followRedirects равно true. Если это количество превышено, будет добавлено событие ошибки с объектом RedirectException.
method → String
только чтение
Метод запроса.
persistentConnection ↔ bool
чтение / запись
Запрошенное состояние постоянного соединения.
runtimeType → Type
только чтениеунаследовано
Представление типа объекта во время выполнения.
uri → Uri
только чтение
URI запроса.

Методы

abort([Object? exception, StackTrace? stackTrace]) → void
Прерывает клиентское соединение.
add(List<int> data) → void
унаследовано
Добавляет байты data целевому получателю, игнорируя кодировку.
addError(Object error, [StackTrace? stackTrace]) → void
унаследовано
Передаёт ошибку целевому получателю как событие ошибки.
addStream(Stream<List<int>> stream) → Future
унаследовано
Добавляет все элементы указанного stream.
close() → Future<HttpClientResponse>
переопределено
Закрывает запрос для ввода. Возвращает значение done.
flush() → Future
унаследовано
Возвращает Future, который завершается, когда все буферизованные данные принимаются базовым StreamConsumer.
noSuchMethod(Invocation invocation) → dynamic
унаследовано
Вызывается при обращении к несуществующему методу или свойству.
toString() → String
унаследовано
Строковое представление этого объекта.
write(Object? object) → void
унаследовано
Преобразует object в строку, вызывая Object.toString, и добавляет кодировку результата целевому получателю с помощью add.
writeAll(Iterable objects, [String separator = ""]) → void
унаследовано
Перебирает указанный objects и последовательно вызывает для его элементов write.
writeCharCode(int charCode) → void
унаследовано
Записывает символ с кодом charCode.
writeln([Object? object = ""]) → void
унаследовано
Преобразует object в строку, вызывая Object.toString, и записывает результат в this, добавляя символ новой строки.

Операторы

operator ==(Object other) → bool
унаследовано
Оператор равенства.

© 2012 the Dart project authors
Licensed under the BSD 3-Clause "New" or "Revised" License.
https://api.dart.dev/stable/2.19.6/dart-io/HttpClientRequest-class.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API