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`.`mail`.`pop3`.`_IteratorBuffer``

class documentation

`class _IteratorBuffer: (source)`

Constructor: `_IteratorBuffer(write, iterable, memoryBufferSize)`

View In Hierarchy

An iterator which buffers the elements of a container and periodically passes them as input to a writer.

Method | `__init__` | No summary
Method | `__iter__` | Return an iterator.
Method | `__next__` | Get the next string from the container, buffer it, and possibly send the buffer to the writer.
Instance Variable | `bufSize` | The number of bytes currently in the buffer.
Instance Variable | `iterator` | An iterator over a container of strings.
Instance Variable | `lines` | The buffer, which is a list of strings.
Instance Variable | `memoryBufferSize` | See `__init__`.
Instance Variable | `write` | See `__init__`.

def __init__(self, write, iterable, memoryBufferSize=None): (source)

Parameters
write:callable that takes `list` of `bytes` | A writer which is a callable that takes a list of strings.
iterable:iterable which yields `bytes` | An iterable container of strings.
memoryBufferSize:`int` or `None` | The number of bytes to buffer before flushing the buffer to the writer.

def __iter__(self): (source)

Return an iterator.

Returns
iterator which yields `bytes` | An iterator over strings.

def __next__(self): (source)

Get the next string from the container, buffer it, and possibly send the buffer to the writer.

The contents of the buffer are written when it is full or when no further values are available from the container.

Raises
`StopIteration` | When no further values are available from the container.

bufSize: `int` = (source)

The number of bytes currently in the buffer.

iterator: iterator which yields `bytes` = (source)

An iterator over a container of strings.

lines: `list` of `bytes` = (source)

The buffer, which is a list of strings.

memoryBufferSize = (source)

See `__init__`.

write = (source)

See `__init__`.