tango.io.vfs.FtpFolder

License:
BSD style:

Version:
August 2008: Initial version

author:
Lester L. Martin II

class FtpFolderEntry: tango.io.vfs.model.Vfs.VfsFolderEntry;
Defines a folder over FTP that has yet to be opened, may not exist, and may be created.

final VfsFolder open();
Open a folder

final VfsFolder create();
Create a new folder

final @property bool exists();
Test to see if a folder exists

class FtpFolder: tango.io.vfs.model.Vfs.VfsFolder;
Represents a FTP Folder in full, allowing one to address specific folders of an FTP File system.

final @property const(char)[] name();
Return a short name

final string toString();
Return a long name

final @property VfsFile file(const(char)[] path);
Return a contained file representation

final @property VfsFolderEntry folder(const(char)[] path);
Return a contained folder representation

final @property VfsFolders self();
Returns a folder set containing only this one. Statistics are inclusive of entries within this folder only

final @property VfsFolders tree();
Returns a subtree of folders. Statistics are inclusive of files within this folder and all others within the tree

final int opApply(scope int delegate(ref VfsFolder) dg);
Iterate over the set of immediate child folders. This is useful for reflecting the hierarchy

final VfsFolder clear();
Clear all content from this folder and subordinates

final @property bool writable();
Is folder writable?

VfsFolder close(bool commit = true);
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

void verify(VfsFolder folder, bool mounting);
A folder is being added or removed from the hierarchy. Use this to test for validity (or whatever) and throw exceptions as necessary

class FtpFolders: tango.io.vfs.model.Vfs.VfsFolders;
A set of folders within an FTP file system as was selected by the Adapter or as was selected at initialization.

final int opApply(scope int delegate(ref VfsFolder) dg);
Iterate over the set of contained VfsFolder instances

final @property size_t files();
Return the number of files

final @property size_t folders();
Return the number of folders

final @property size_t entries();
Return the total number of entries (files + folders)

final @property ulong bytes();
Return the total size of contained files

final VfsFolders subset(const(char)[] pattern);
Return a subset of folders matching the given pattern

final @property VfsFiles catalog(const(char)[] pattern);
Return a set of files matching the given pattern

final @property VfsFiles catalog(VfsFilter filter = null);
Return a set of files matching the given filter

class FtpFile: tango.io.vfs.model.Vfs.VfsFile;
Represents a file over a FTP file system.

final @property const(char)[] name();
Return a short name

final string toString();
Return a long name

final @property bool exists();
Does this file exist?

final @property ulong size();
Return the file size

final VfsFile copy(VfsFile source);
Create and copy the given source

final VfsFile move(VfsFile source);
Create and copy the given source, and remove the source

final VfsFile create();
Create a new file instance

final VfsFile create(InputStream stream);
Create a new file instance and populate with stream

final VfsFile remove();
Remove this file

final @property InputStream input();
Return the input stream. Don't forget to close it

final @property OutputStream output();
Return the output stream. Don't forget to close it

final @property VfsFile dup();
Duplicate this entry

final @property Time.Time mtime();
Time modified

final @property Time.Time ctime();
Time created

final @property Time.Time modified();
Modified time of the file

class FtpFiles: tango.io.vfs.model.Vfs.VfsFiles;
Represents a selection of Files.

final int opApply(scope int delegate(ref VfsFile) dg);
Iterate over the set of contained VfsFile instances

final @property size_t files();
Return the total number of entries

final @property ulong bytes();
Return the total size of all files


Page generated by Ddoc. Copyright (c) 2007-2008 Tango. All rights reserved