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`.`spread`.`util``

module documentation
(source)

Utility classes for spread.

Class | `CallbackPageCollector` | I receive pages from the peer. You may instantiate a Pager with a remote reference to me. I will call the callback with a list of pages once they are all received.
Class | `FilePager` | Reads a file in chunks and sends the chunks as they come.
Class | `LocalAsRemote` | A class useful for emulating the effects of remote behavior locally.
Class | `LocalAsyncForwarder` | A class useful for forwarding a locally-defined interface.
Class | `LocalMethod` | Undocumented
Class | `Pager` | I am an object which pages out information.
Class | `StringPager` | A simple pager that splits a string into chunks.
Function | `getAllPages` | A utility method that will call a remote method which expects a PageCollector as the first argument.

def getAllPages(referenceable, methodName, *args, **kw): (source)

A utility method that will call a remote method which expects a PageCollector as the first argument.