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`.`protocols`.`ftp`.`_FileReader``

class documentation

`class _FileReader: (source)`

Implements interfaces: `twisted.protocols.ftp.IReadFile`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `send` | Produce the contents of the given path to the given consumer. This method may only be invoked once on each provider.
Instance Variable | `fObj` | Undocumented
Method | `_close` | Undocumented
Instance Variable | `_send` | Undocumented

def __init__(self, fObj): (source)

Undocumented

def send(self, consumer): (source)
from `twisted.protocols.ftp.IReadFile`

Produce the contents of the given path to the given consumer. This method may only be invoked once on each provider.

Parameters
consumer:`IConsumer` | Undocumented
Returns
A Deferred which fires when the file has been consumed completely.

fObj = (source)

Undocumented

def _close(self, passthrough): (source)

Undocumented

_send: `bool` = (source)

Undocumented