Make IOSink implement StringSink

sdk/lib/io/http.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 part of dart.io;
 
 /**
  * HTTP status codes.
  */
 abstract class HttpStatus {
@@ skipping 658 matching lines @@
   /**
    * Gets the [HttpResponse] object, used for sending back the response to the
    * client.
    */
   HttpResponse get response;
 }
 
 
 /**
  * HTTP response to be send back to the client.
+ *
+ * This object has a number of properties for setting up the HTTP
+ * header of the response. Then the header has been set up the methods

[Anders Johnsen, 2013/03/07 16:53:49]

Then -> When ?

[Søren Gjesse, 2013/03/08 09:47:46]

Done.

+ * from the [IOSink] can be used to write the actual body of the HTTP
+ * response. When one of the [IOSink] methods this is used for the

[Anders Johnsen, 2013/03/07 16:53:49]

Remove 'this'.

[Søren Gjesse, 2013/03/08 09:47:46]

Done.

+ * first time the request header is send. Calling any methods that
+ * will change the header after it is sent will throw an exception.
+ *
+ * When writing string data through the [IOSink] the encoding used
+ * will be determined from the "charset" parameter of the
+ * "Content-Type" header.
+ *
+ *   HttpResponse response = ...
+ *   response.headers.contentType
+ *       = new ContentType("application", "json", charset: "utf-8");
+ *   response.write(...);  // Strings written will be UTF-8 encoded.
+ *
+ * If no charset is provided the default of ISO-8859-1 (Latin 1) will
+ * be used.
+ *
+ *   HttpResponse response = ...
+ *   response.headers.add(HttpHeaders.CONTENT_TYPE, "text/plain");
+ *   response.write(...);  // Strings written will be ISO-8859-1 encoded.
+ *
+ * If an unsupported encoding is used an exception will be thrown.

[nweiz, 2013/03/07 19:32:05]

Specify that the exception will only be thrown when [IOSink.write] is called.

[Søren Gjesse, 2013/03/08 09:47:46]

Done.

  */
 abstract class HttpResponse implements IOSink<HttpResponse> {
   // TODO(ajohnsen): Add documentation of how to pipe a file to the response.
   /**
    * Gets and sets the content length of the response. If the size of
    * the response is not known in advance set the content length to
    * -1 - which is also the default if not set.
    */
   int contentLength;
 
@@ skipping 164 matching lines @@
    * trying to establish a new connection after calling [shutdown]
    * will throw an exception.
    */
   void close({bool force: false});
 }
 
 
 /**
  * HTTP request for a client connection.
  *
- * The request is an [IOSink], used to write the request data. When
- * all request data has been written, close the stream to indicate the end of
- * the request.
+ * This object has a number of properties for setting up the HTTP
+ * header of the request. Then the header has been set up the methods

[Anders Johnsen, 2013/03/07 16:53:49]

Then -> When

[Søren Gjesse, 2013/03/08 09:47:46]

Done.

+ * from the [IOSink] can be used to write the actual body of the HTTP
+ * request. When one of the [IOSink] methods this is used for the

[Anders Johnsen, 2013/03/07 16:53:49]

Remove 'this'.

[Søren Gjesse, 2013/03/08 09:47:46]

Done.

+ * first time the request header is send. Calling any methods that
+ * will change the header after it is sent will throw an exception.
  *
- * When this is accessed for the first time the request header is
- * send. Calling any methods that will change the header after
- * having retrieved the output stream will throw an exception.
+ * When writing string data through the [IOSink] the
+ * encoding used will be determined from the "charset" parameter of
+ * the "Content-Type" header.
+ *
+ *   HttpClientRequest request = ...
+ *   request.headers.contentType
+ *       = new ContentType("application", "json", charset: "utf-8");
+ *   request.write(...);  // Strings written will be UTF-8 encoded.
+ *
+ * If no charset is provided the default of ISO-8859-1 (Latin 1) will
+ * be used.
+ *
+ *   HttpClientRequest request = ...
+ *   request.headers.add(HttpHeaders.CONTENT_TYPE, "text/plain");
+ *   request.write(...);  // Strings written will be ISO-8859-1 encoded.
+ *
+ * If an unsupported encoding is used an exception will be thrown.

[nweiz, 2013/03/07 19:32:05]

Also here.

[Søren Gjesse, 2013/03/08 09:47:46]

Done.

  */
 abstract class HttpClientRequest
     implements IOSink<HttpClientRequest> {
   /**
    * Gets and sets the content length of the request. If the size of
    * the request is not known in advance set content length to -1,
    * which is also the default.
    */
   int contentLength;
 
@@ skipping 241 matching lines @@
 class RedirectLimitExceededException extends RedirectException {
   const RedirectLimitExceededException(List<RedirectInfo> redirects)
       : super("Redirect limit exceeded", redirects);
 }
 
 
 class RedirectLoopException extends RedirectException {
   const RedirectLoopException(List<RedirectInfo> redirects)
       : super("Redirect loop detected", redirects);
 }