|
System.Gnome.VFS.Xfer | Maintainer | gtk2hs-devel@lists.sourceforge.net
Stability : alpha
Portability : portable (depends on GHC) |
|
|
|
|
|
Description |
|
|
Synopsis |
|
|
|
|
Types
|
|
data XferProgressInfo |
Constructors | XferProgressInfo | | xferProgressInfoVFSStatus :: Result | current VFS status
| xferProgressInfoPhase :: XferPhase | phase of the transfer
| xferProgressInfoSourceName :: (Maybe String) | currently transferring source URI
| xferProgressInfoTargetName :: (Maybe String) | currently transferring target URI
| xferProgressInfoFileIndex :: Word | index of the file currently being transferred
| xferProgressInfoFilesTotal :: Word | total number of files being transferred
| xferProgressInfoBytesTotal :: FileSize | total size of all files in bytes
| xferProgressInfoFileSize :: FileSize | size of the file currently being transferred
| xferProgressInfoBytesCopied :: FileSize | number of bytes already transferred in the current file
| xferProgressInfoTotalBytesCopied :: FileSize | total number of bytes already transferred
| xferProgressInfoTopLevelItem :: Bool | True if the file being transferred is a top-level item;
False if it is inside a directory
|
|
| Instances | |
|
|
data XferOptions |
Options controlling how the xferURI and related functions behave.
| Constructors | XferFollowLinks | | XferRecursive | | XferSamefs | | XferDeleteItems | | XferEmptyDirectories | | XferNewUniqueDirectory | | XferRemovesource | | XferUseUniqueNames | | XferLinkItems | | XferFollowLinksRecursive | | XferTargetDefaultPerms | |
| Instances | |
|
|
data XferOverwriteMode |
Constructors | XferOverwriteModeAbort | | XferOverwriteModeReplace | | XferOverwriteModeSkip | |
| Instances | |
|
|
data XferErrorAction |
Constructors | XferErrorActionAbort | | XferErrorActionRetry | | XferErrorActionSkip | |
| Instances | |
|
|
data XferOverwriteAction |
Constructors | XferOverwriteActionAbort | | XferOverwriteActionReplace | | XferOverwriteActionReplaceAll | | XferOverwriteActionSkip | | XferOverwriteActionSkipAll | |
| Instances | |
|
|
type XferProgressCallback = XferProgressInfo -> IO Bool |
The type of the first callback that is passed to
xferURI and related functions. This
callback will be called periodically during transfers that are
progressing normally.
The callback must return False to abort the transfer, or True otherwise.
|
|
type XferErrorCallback = XferProgressInfo -> IO XferErrorAction |
The type of the second callback that is passed to
xferURI. This callback will be called
whenever an error occurs.
The callback must return the action to be performed in response to the error.
|
|
type XferOverwriteCallback = XferProgressInfo -> IO XferOverwriteAction |
The type of the third callback that is passed to
xferURI. This callback will be called
when a file would be overwritten.
The callback must return the action to be performed when the target file already exists.
|
|
type XferDuplicateCallback = XferProgressInfo -> String -> Int -> IO (Maybe String) |
The type of the fourth callback that is passed to
xferURI. This callback will be called
when a duplicate filename is found.
The parameters, from left to right, are:
* info - information about the progress of the current transfer,
* duplicateName - the name of the target file,
* duplicateCount - the number of duplicates that exist.
The callback must return the new filename that should be used, or Nothing to abort.
|
|
Operations
|
|
xferURI |
|
|
xferURIList |
|
|
xferDeleteList |
|
|
Produced by Haddock version 0.8 |