class documentation

class twisted.conch.ssh.filetransfer.ClientFile: (source)

Implements interfaces: twisted.conch.interfaces.ISFTPFile

View In Hierarchy

Undocumented

Method __init__ Undocumented
Instance Variable parent Undocumented
Instance Variable handle Undocumented
Method close Close the file.
Method readChunk Read from the file.
Method writeChunk Write to the file.
Method getAttrs Return the attributes for the file.
Method setAttrs Set the attributes for the file.
def __init__(self, parent, handle): (source)

Undocumented

parent = (source)

Undocumented

handle = (source)

Undocumented

def close(self): (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 readChunk(self, 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.

Parametersoffsetan integer that is the index to start from in the file.
lengththe 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 writeChunk(self, offset, chunk): (source)

Write to the file.

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

Parametersoffsetan integer that is the index to start from in the file.
chunkUndocumented
dataa string that is the data to write.
def getAttrs(self): (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 setAttrs(self, 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.

Parametersattrsa dictionary in the same format as the attrs argument to openFile.
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.