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`.`server`.`_GzipEncoder``

class documentation

`class _GzipEncoder: (source)`

Implements interfaces: `twisted.web.iweb._IRequestEncoder`

View In Hierarchy

An encoder which supports gzip.

Present Since
12.3

Method | `__init__` | Undocumented
Method | `encode` | Write to the request, automatically compressing data on the fly.
Method | `finish` | Finish handling the request request, flushing any data from the zlib buffer.
Instance Variable | `_request` | A reference to the originating request.
Instance Variable | `_zlibCompressor` | The zlib compressor instance used to compress the stream.

def __init__(self, compressLevel, request): (source)

Undocumented

def encode(self, data): (source)
from `twisted.web.iweb._IRequestEncoder`

Write to the request, automatically compressing data on the fly.

def finish(self): (source)
from `twisted.web.iweb._IRequestEncoder`

Finish handling the request request, flushing any data from the zlib buffer.

_request = (source)

A reference to the originating request.

_zlibCompressor = (source)

The zlib compressor instance used to compress the stream.