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

class documentation

`class CallbackPageCollector(pb.Referenceable): (source)`

Constructor: `CallbackPageCollector(callback)`

View In Hierarchy

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.

Method | `__init__` | Undocumented
Method | `remote_endedPaging` | Undocumented
Method | `remote_gotPage` | Undocumented
Instance Variable | `callback` | Undocumented
Instance Variable | `pages` | Undocumented

Inherited from `Referenceable`:

Method | `jellyFor` | (internal)
Method | `remoteMessageReceived` | A remote message has been received. Dispatch it appropriately.
Class Variable | `perspective` | I am an object sent remotely as a direct reference.

Inherited from `Serializable` (via `Referenceable`):

Method | `processUniqueID` | Return an ID which uniquely represents this object for this process.

Inherited from `Jellyable` (via `Referenceable`, `Serializable`):

Method | `getStateFor` | Undocumented

def __init__(self, callback): (source)

Undocumented

def remote_endedPaging(self): (source)

Undocumented

def remote_gotPage(self, page): (source)

Undocumented

callback = (source)

Undocumented

pages: `list` = (source)

Undocumented