LinkedFolder

LinkedFolder is derived from VirtualFolder, and behaves exactly the same in all but one aspect: it treats mounted folders as an ordered list of alternatives to look for a file. This supports the notion of file 'overrides', whereby "customized" files can be inserted into a chain of alternatives.

(Overridden folders are not currently supported.)

class LinkedFolder : VirtualFolder {

this(istring name);

VfsHost mount(VfsFolder folder, istring name);

VfsHost dismount(VfsFolder folder);

VfsFile file(istring path);

}

Constructors

this this(istring name): All folder must have a name. No '.' or '/' chars are permitted.

Members

Functions

dismount VfsHost dismount(VfsFolder folder): TODO: Unhook a child folder.
file VfsFile file(istring path): Return a file representation of the given path. If the path-head does not refer to an immediate child folder, and does not match a symbolic link, it is considered to be unknown.
mount VfsHost mount(VfsFolder folder, istring name): Add a child folder. The child cannot 'overlap' with others in the tree of the same type. Circular references across a tree of virtual folders are detected and trapped.

Inherited Members

From VirtualFolder

name istring name(): Return the (short) name of this folder.
toString istring toString(): Return the (long) name of this folder. Virtual folders do not have long names, since they don't relate directly to a concrete folder instance.
mount VfsHost mount(VfsFolder folder, istring name): Add a child folder. The child cannot 'overlap' with others in the tree of the same type. Circular references across a tree of virtual folders are detected and trapped.
mount VfsHost mount(VfsFolders group): Add a set of child folders. The children cannot 'overlap' with others in the tree of the same type. Circular references are detected and trapped.
dismount VfsHost dismount(VfsFolder folder): Unhook a child folder.
map VfsHost map(VfsFile file, istring name): Add a symbolic link to another file. These are referenced by file() alone, and do not show up in tree traversals.
map VfsHost map(VfsFolderEntry folder, istring name): Add a symbolic link to another folder. These are referenced by folder() alone, and do not show up in tree traversals.
opApply int opApply(int delegate(ref VfsFolder) dg): Iterate over the set of immediate child folders. This is useful for reflecting the hierarchy.
folder VfsFolderEntry folder(istring path): Return a folder representation of the given path. If the path-head does not refer to an immediate child, and does not match a symbolic link, it is considered unknown.
file VfsFile file(istring path): Return a file representation of the given path. If the path-head does not refer to an immediate child folder, and does not match a symbolic link, it is considered unknown.
clear VfsFolder clear(): Clear the entire subtree. Use with caution.
writable bool writable(): Returns true if all of the children are writable.
self VfsFolders self(): Returns a folder set containing only this one. Statistics are inclusive of entries within this folder only, which should be zero since symbolic links are not included.
tree VfsFolders tree(): Returns a subtree of folders. Statistics are inclusive of all files and folders throughout the sub-tree.
verify void verify(VfsFolder folder, bool mounting): Sweep the subtree of mountpoints, testing a new folder against all others. This propogates a folder test down throughout the tree, where each folder implementation should take appropriate action.
close VfsFolder close(bool commit): Close and/or synchronize changes made to this folder. Each driver should take advantage of this as appropriate, perhaps combining multiple files together, or possibly copying to a remote location.
error istring error(istring msg): Throw an exception.