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`.`mail`.`imap4`.`FileProducer``

class documentation

`class FileProducer: (source)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `beginProducing` | Undocumented
Method | `pauseProducing` | Pause the producer. This does nothing.
Method | `resumeProducing` | Undocumented
Method | `stopProducing` | Stop the producer. This does nothing.
Constant | `CHUNK_SIZE` | Undocumented
Instance Variable | `consumer` | Undocumented
Instance Variable | `f` | Undocumented
Instance Variable | `firstWrite` | Undocumented
Instance Variable | `produce` | Undocumented
Method | `_size` | Undocumented
Instance Variable | `_onDone` | Undocumented

def __init__(self, f): (source)

Undocumented

def beginProducing(self, consumer): (source)

Undocumented

def pauseProducing(self): (source)

Pause the producer. This does nothing.

def resumeProducing(self): (source)

Undocumented

def stopProducing(self): (source)

Stop the producer. This does nothing.

CHUNK_SIZE = (source)

Undocumented

Value

    2**(2**(2**2))

consumer = (source)

Undocumented

f = (source)

Undocumented

firstWrite: `bool` = (source)

Undocumented

produce = (source)

Undocumented

def _size(self): (source)

Undocumented

_onDone = (source)

Undocumented