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`.`conch`.`ssh`.`filetransfer`.`ClientDirectory``

class documentation

`class ClientDirectory: (source)`

Constructor: `ClientDirectory(parent, handle)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `__iter__` | Undocumented
Method | `__next__` | Undocumented
Method | `close` | Undocumented
Method | `read` | Undocumented
Instance Variable | `filesCache` | Undocumented
Instance Variable | `handle` | Undocumented
Instance Variable | `parent` | Undocumented
Method | `_cbReadDir` | Undocumented
Method | `_ebReadDir` | Undocumented

def __init__(self, parent, handle): (source)

Undocumented

def __iter__(self): (source)

Undocumented

def __next__(self): (source)

Undocumented

def close(self): (source)

Undocumented

def read(self): (source)

Undocumented

filesCache = (source)

Undocumented

handle = (source)

Undocumented

parent = (source)

Undocumented

def _cbReadDir(self, names): (source)

Undocumented

def _ebReadDir(self, reason): (source)

Undocumented