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

class documentation

`class StringPager(Pager): (source)`

View In Hierarchy

A simple pager that splits a string into chunks.

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.
Instance Variable | `chunkSize` | Undocumented
Instance Variable | `pointer` | Undocumented
Instance Variable | `string` | Undocumented

Inherited from `Pager`:

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, st, chunkSize=8192, callback=None, *args, **kw): (source)
overrides `twisted.spread.util.Pager.__init__`

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

def nextPage(self): (source)
overrides `twisted.spread.util.Pager.nextPage`

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

chunkSize = (source)

Undocumented

pointer: `int` = (source)

Undocumented

string = (source)

Undocumented