Class t.v.a.s.AdaptFileSystemLeafToISFTPFile:

Part of twisted.vfs.adapters.sftp View Source View In Hierarchy

Implements interfaces: twisted.conch.interfaces.ISFTPFile

Undocumented
Line # Kind Name Docs
219 Method __init__ Undocumented
222 Method close Close the file.
225 Method readChunk Read from the file.
228 Method writeChunk Write to the file.
231 Method getAttrs Return the attributes for the file.
234 Method setAttrs Set the attributes for the file.
def __init__(self, original):
Undocumented
def close(self):
from twisted.conch.interfaces.ISFTPFile

Close the file.

This method returns nothing if the close succeeds immediatly, or a Deferred that is called back when the close succeeds.
def readChunk(self, offset, length):
from twisted.conch.interfaces.ISFTPFile

Read from the file.

offset is an integer that is the index to start from in the file. length is 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).

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.
def writeChunk(self, offset, data):
from twisted.conch.interfaces.ISFTPFile

Write to the file.

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

This method returns when the write completes, or a Deferred that is called when it completes.
def getAttrs(self):
from twisted.conch.interfaces.ISFTPFile

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):
from twisted.conch.interfaces.ISFTPFile

Set the attributes for the file.

attrs is a dictionary in the same format as the attrs argument to openFile.

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