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`.`resource`.`EncodingResourceWrapper``

class documentation

`class EncodingResourceWrapper(proxyForInterface(IResource)): (source)`

Constructor: `EncodingResourceWrapper(original, encoders)`

Implements interfaces: `twisted.web.resource._IEncodingResource`

View In Hierarchy

Wrap a `IResource`, potentially applying an encoding to the response body generated.

Note that the returned children resources won't be wrapped, so you have to explicitly wrap them if you want the encoding to be applied.

Present Since
12.3

Method | `__init__` | Undocumented
Method | `getEncoder` | Browser the list of encoders looking for one applicable encoder.
Instance Variable | `encoders` | A list of `_IRequestEncoderFactory` returning `_IRequestEncoder` that may transform the data passed to `Request.write`. The list must be sorted in order of priority: the first encoder factory handling the request will prevent the others from doing the same.
Instance Variable | `_encoders` | Undocumented

def __init__(self, original, encoders): (source)

Undocumented

def getEncoder(self, request): (source)
from `twisted.web.resource._IEncodingResource`

Browser the list of encoders looking for one applicable encoder.

encoders: `list`. = (source)

A list of `_IRequestEncoderFactory` returning `_IRequestEncoder` that may transform the data passed to `Request.write`. The list must be sorted in order of priority: the first encoder factory handling the request will prevent the others from doing the same.

_encoders = (source)

Undocumented