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`.`interfaces`.`ISFTPFile``

interface documentation

`class ISFTPFile(Interface): (source)`

Known implementations: `twisted.conch.ssh.filetransfer.ClientFile`, `twisted.conch.unix.UnixSFTPFile`

View In Hierarchy

This represents an open file on the server. An object adhering to this interface should be returned from `openFile`().

Method | `close` | Close the file.
Method | `getAttrs` | Return the attributes for the file.
Method | `readChunk` | Read from the file.
Method | `setAttrs` | Set the attributes for the file.
Method | `writeChunk` | Write to the file.

def close(): (source)

Close the file.

This method returns nothing if the close succeeds immediately, or a Deferred that is called back when the close succeeds.

def getAttrs(): (source)

Return the attributes for the file.

This method returns a dictionary in the same format as the attrs argument to `openFile` or a `Deferred` that is called back with same.

def readChunk(offset, length): (source)

Read from the file.

If EOF is reached before any data is read, raise EOFError.

This method returns the data as a string, or a Deferred that is called back with same.

Parameters
offset | an integer that is the index to start from in the file.
length | the maximum length of data to return. The actual amount returned may less than this. For normal disk files, however, this should read the requested number (up to the end of the file).

def setAttrs(attrs): (source)

Set the attributes for the file.

This method returns when the attributes are set or a Deferred that is called back when they are.

Parameters
attrs | a dictionary in the same format as the attrs argument to `openFile`.

def writeChunk(offset, data): (source)

Write to the file.

This method returns when the write completes, or a Deferred that is called when it completes.

Parameters
offset | an integer that is the index to start from in the file.
data | a string that is the data to write.