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`.`internet`.`interfaces`.`IReadDescriptor``

interface documentation

`class IReadDescriptor(IFileDescriptor): (source)`

Known subclasses: `twisted.internet.interfaces.IReadWriteDescriptor`

Known implementations: `twisted.internet._signals._FDWaker`

View In Hierarchy

An `IFileDescriptor` that can read.

This interface is generally used in conjunction with `IReactorFDSet`.

Method | `doRead` | Some data is available for reading on your descriptor.

Inherited from `IFileDescriptor`:

Method | `connectionLost` | Called when the connection was lost.
Method | `fileno` | No summary

Inherited from `ILoggingContext` (via `IFileDescriptor`):

Method | `logPrefix` | No summary

def doRead() -> `Optional[Failure]`: (source)

Some data is available for reading on your descriptor.

Returns
`Optional[Failure]` | If an error is encountered which causes the descriptor to no longer be valid, a `Failure` should be returned. Otherwise, `None`.