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`.`Pager``

class documentation

`class Pager: (source)`

Known subclasses: `twisted.spread.util.FilePager`, `twisted.spread.util.StringPager`

Constructor: `Pager(collector, callback, *args, **kw)`

View In Hierarchy

I am an object which pages out information.

Method | `__init__` | Create a pager with a Reference to a remote collector and an optional callable to invoke upon completion.
Method | `nextPage` | Override this to return an object to be sent to my collector.
Method | `sendNextPage` | (internal) Method called by Broker.
Method | `stillPaging` | (internal) Method called by Broker.
Method | `stopPaging` | Call this when you're done paging.
Instance Variable | `callback` | Undocumented
Instance Variable | `callbackArgs` | Undocumented
Instance Variable | `callbackKeyword` | Undocumented
Instance Variable | `collector` | Undocumented
Instance Variable | `_stillPaging` | Undocumented

def __init__(self, collector, callback=None, *args, **kw): (source)
overridden in `twisted.spread.util.FilePager`, `twisted.spread.util.StringPager`

Create a pager with a Reference to a remote collector and an optional callable to invoke upon completion.

def nextPage(self): (source)
overridden in `twisted.spread.util.StringPager`

Override this to return an object to be sent to my collector.

def sendNextPage(self): (source)
overridden in `twisted.spread.util.FilePager`

(internal) Method called by Broker.

def stillPaging(self): (source)

(internal) Method called by Broker.

def stopPaging(self): (source)

Call this when you're done paging.

callback = (source)

Undocumented

callbackArgs = (source)

Undocumented

callbackKeyword = (source)

Undocumented

collector = (source)

Undocumented

_stillPaging: `int` = (source)

Undocumented