t.v.i.IFileSystemLeaf(IFileSystemNode) : interface documentation

Part of twisted.vfs.ivfs View Source View In Hierarchy

Known implementations: twisted.vfs.backends.inmem.FakeFile, twisted.vfs.backends.osfs.OSFile

No interface docstring
Method open Opens the file with flags. Flags should be a bitmask based on the os.O_* flags.
Method close Closes this node.
Method readChunk Leaf should have been previously opened with suitable flags. Reads length bytes or until the end of file from this leaf from the given offset.
Method writeChunk Leaf should have been previously opened with suitable flags. Writes data to leaf from the given offset.

Inherited from IFileSystemNode:

Attribute parent parent node
Method getMetadata Feturns a map of arbitrary metadata. As an example, here's what SFTP expects (but doesn't require):
Method remove Removes this node. An error is raised if the node is a directory and is not empty.
Method rename Renames this node to newName. newName can be in a different directory. If the destination is an existing directory, an error will be raised.
def open(flags): (source)
Opens the file with flags. Flags should be a bitmask based on the os.O_* flags.
def close(): (source)
Closes this node.
def readChunk(offset, length): (source)
Leaf should have been previously opened with suitable flags. Reads length bytes or until the end of file from this leaf from the given offset.
def writeChunk(offset, data): (source)
Leaf should have been previously opened with suitable flags. Writes data to leaf from the given offset.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.