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

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

Known implementations: twisted.vfs.backends.adhoc.AdhocDirectory, twisted.vfs.backends.inmem.FakeDirectory, twisted.vfs.backends.osfs.OSDirectory

No interface docstring
Method children Returns a list of 2 element tuples [ ( path, nodeObject ) ]. The first two elements of the list are '.' (the node itself), and '..' (the node parent).
Method child Returns a node object for child childName.
Method createDirectory Creates a new folder named childName under this folder. An error is raised if the folder already exists.
Method createFile Creates a new file named childName under this folder.
Method exists Returns True if container has a child childName, False otherwise.

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 children(): (source)
Returns a list of 2 element tuples [ ( path, nodeObject ) ]. The first two elements of the list are '.' (the node itself), and '..' (the node parent).
def child(childName): (source)
Returns a node object for child childName.
RaisesNotFoundError if no child with that name exists.
def createDirectory(childName): (source)
Creates a new folder named childName under this folder. An error is raised if the folder already exists.
def createFile(childName, exclusive=True): (source)

Creates a new file named childName under this folder.

If exclusive is True (the default), an AlreadyExistsError is raised if the file already exists.
def exists(childName): (source)
Returns True if container has a child childName, False otherwise.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:22:34.