Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`web`.`_newclient`.`ChunkedEncoder``

class documentation

`class ChunkedEncoder: (source)`

Constructor: `ChunkedEncoder(transport)`

Implements interfaces: `twisted.internet.interfaces.IConsumer`

View In Hierarchy

Helper object which exposes `IConsumer` on top of `HTTP11ClientProtocol` for streaming request bodies to the server.

Method | `__init__` | Undocumented
Method | `registerProducer` | Register the given producer with `self.transport`.
Method | `unregisterProducer` | Indicate that the request body is complete and finish the request.
Method | `write` | Write the given request body bytes to the transport using chunked encoding.
Instance Variable | `transport` | Undocumented
Method | `_allowNoMoreWrites` | Indicate that no additional writes are allowed. Attempts to write after calling this method will be met with an exception.

def __init__(self, transport): (source)

Undocumented

def registerProducer(self, producer, streaming): (source)
from `twisted.internet.interfaces.IConsumer`

Register the given producer with `self.transport`.

def unregisterProducer(self): (source)
from `twisted.internet.interfaces.IConsumer`

Indicate that the request body is complete and finish the request.

def write(self, data): (source)
from `twisted.internet.interfaces.IConsumer`

Write the given request body bytes to the transport using chunked encoding.

Parameters
data:`bytes` | Undocumented

transport = (source)

Undocumented

def _allowNoMoreWrites(self): (source)

Indicate that no additional writes are allowed. Attempts to write after calling this method will be met with an exception.