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`.`internet`.`testing`.`NonStreamingProducer``

class documentation

`class NonStreamingProducer: (source)`

Constructor: `NonStreamingProducer(consumer)`

View In Hierarchy

A pull producer which writes 10 times only.

Method | `__init__` | Undocumented
Method | `pauseProducing` | An implementation of `IPushProducer.pauseProducing`. This should never be called on a pull producer, so this just raises an error.
Method | `resumeProducing` | Write the counter value once.
Method | `stopProducing` | Stop all production.
Class Variable | `counter` | Undocumented
Instance Variable | `consumer` | Undocumented
Instance Variable | `result` | Undocumented
Instance Variable | `stopped` | Undocumented
Method | `_done` | Fire a `Deferred` so that users can wait for this to complete.

def __init__(self, consumer): (source)

Undocumented

def pauseProducing(self): (source)

An implementation of `IPushProducer.pauseProducing`. This should never be called on a pull producer, so this just raises an error.

def resumeProducing(self): (source)

Write the counter value once.

def stopProducing(self): (source)

Stop all production.

counter: `int` = (source)

Undocumented

consumer = (source)

Undocumented

result = (source)

Undocumented

stopped: `bool` = (source)

Undocumented

def _done(self): (source)

Fire a `Deferred` so that users can wait for this to complete.