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`.`trial`.`_dist`.`stream`.`StreamReceiver``

class documentation

`class StreamReceiver: (source)`

View In Hierarchy

Buffering de-multiplexing byte stream receiver.

Method | `finish` | Indicate an open stream may receive no further data and return all of its current contents.
Method | `open` | Open a new stream and return its unique identifier.
Method | `write` | Write to an open stream using its unique identifier.
Class Variable | `_counter` | Undocumented
Class Variable | `_streams` | Undocumented

def finish(self, streamId: `int`) -> `List[bytes]`: (source)

Indicate an open stream may receive no further data and return all of its current contents.

Raises
`KeyError` | If there is no such open stream.

def open(self) -> `int`: (source)

Open a new stream and return its unique identifier.

def write(self, streamId: `int`, chunk: `bytes`): (source)

Write to an open stream using its unique identifier.

Raises
`KeyError` | If there is no such open stream.

_counter: `Iterator[int]` = (source)

Undocumented

_streams: `Dict[int, List[bytes]]` = (source)

Undocumented