gnomevfs-0.11.0: Binding to the GNOME Virtual File System library.Source codeContentsIndex
System.Gnome.VFS.Directory
Portabilityportable (depends on GHC)
Stabilityalpha
Maintainergtk2hs-devel@lists.sourceforge.net
Contents
Types
Directory Creation
Directory Removal
Directory Access
Directory Traversal
Description
Functions for creating, removing, and accessing directories and their contents.
Synopsis
data DirectoryHandle
data DirectoryVisitOptions
= DirectoryVisitDefault
| DirectoryVisitSamefs
| DirectoryVisitLoopcheck
| DirectoryVisitIgnoreRecurseError
data DirectoryVisitResult
= DirectoryVisitStop
| DirectoryVisitContinue
| DirectoryVisitRecurse
makeDirectory :: TextURI -> [FilePermissions] -> IO ()
makeDirectoryForURI :: URI -> [FilePermissions] -> IO ()
removeDirectory :: TextURI -> IO ()
removeDirectoryFromURI :: URI -> IO ()
directoryOpen :: TextURI -> [FileInfoOptions] -> IO DirectoryHandle
directoryOpenFromURI :: URI -> [FileInfoOptions] -> IO DirectoryHandle
directoryReadNext :: DirectoryHandle -> IO FileInfo
directoryClose :: DirectoryHandle -> IO ()
directoryListLoad :: TextURI -> [FileInfoOptions] -> IO [FileInfo]
directoryVisit :: String -> [FileInfoOptions] -> [DirectoryVisitOptions] -> DirectoryVisitCallback -> IO ()
directoryVisitURI :: URI -> [FileInfoOptions] -> [DirectoryVisitOptions] -> DirectoryVisitCallback -> IO ()
directoryVisitFiles :: TextURI -> [String] -> [FileInfoOptions] -> [DirectoryVisitOptions] -> DirectoryVisitCallback -> IO ()
directoryVisitFilesAtURI :: URI -> [String] -> [FileInfoOptions] -> [DirectoryVisitOptions] -> DirectoryVisitCallback -> IO ()
Types
data DirectoryHandle Source
A handle to an open directory.
data DirectoryVisitOptions Source
Options controlling the way in which a directories are visited.
Constructors
DirectoryVisitDefault
DirectoryVisitSamefs
DirectoryVisitLoopcheck
DirectoryVisitIgnoreRecurseError
data DirectoryVisitResult Source
An enumerated value that must be returned from a DirectoryVisitCallback. The directoryVisit and related functions will perform the action specified.
Constructors
DirectoryVisitStopstop visiting files
DirectoryVisitContinuecontinue as normal
DirectoryVisitRecurserecursively visit the current entry
Directory Creation
makeDirectorySource
:: TextURItextURI - String representation of the URI of the directory to create
-> [FilePermissions]perm - FilePermissions for the newly created directory
-> IO ()
Create textURI as a directory. Only succeeds if a file or directory does not already exist at textURI.
makeDirectoryForURISource
:: URIuri - URI of the directory to be created
-> [FilePermissions]perm - FilePermissions for the newly created directory
-> IO ()
Create uri as a directory. Only succeeds if a file or directory does not already exist at uri.
Directory Removal
removeDirectorySource
:: TextURItextURI - URI of the directory to be removed
-> IO ()
Remove the directory at textURI. The object at textURI must be an empty directory.
removeDirectoryFromURISource
:: URIuri - URI of the directory to be removed
-> IO ()
Remove the directory at uri. The object at uri must be an empty directory.
Directory Access
directoryOpenSource
:: TextURItextURI - String representation of the URI of the directory to open
-> [FileInfoOptions]fileInfoOptions - options for reading file information
-> IO DirectoryHandlehandle to the opened directory
Open directory textURI for reading. Returns a DirectoryHandle which can be used to read directory entries one by one.
directoryOpenFromURISource
:: URIuri - URI of the directory to open
-> [FileInfoOptions]fileInfoOptions - options for reading file information
-> IO DirectoryHandlehandle to the opened directory
Open directory textURI for reading. Returns a DirectoryHandle which can be used to read directory entries one by one.
directoryReadNextSource
:: DirectoryHandlehandle - a directory handle
-> IO FileInfofile information for the next directory entry
Read the next directory entry from a DirectoryHandle.
directoryCloseSource
:: DirectoryHandlehandle - a directory handle
-> IO ()
Close a DirectoryHandle.
directoryListLoadSource
:: TextURItextURI - String representation of the URI of the directory to load
-> [FileInfoOptions]options - options for reading file information
-> IO [FileInfo]the entries contined in the directory
Create a list of FileInfo objects representing each entry in the directory at textURI, using options options.
Directory Traversal
directoryVisitSource
:: StringtextURI - string representation of the URI of the directory to visit
-> [FileInfoOptions]infoOptions - options for reading file information
-> [DirectoryVisitOptions]visitOptions - options for visiting the directory
-> DirectoryVisitCallbackcallback - a function to be called for each entry
-> IO ()
Visit each entry in a directory at a TextURI, calling a DirectoryVisitCallback for each one.
directoryVisitURISource
:: URIuri - the URI of the directory to visit
-> [FileInfoOptions]infoOptions - options for reading file information
-> [DirectoryVisitOptions]visitOptions - options for visiting the directory
-> DirectoryVisitCallbackcallback - a function to be called for each entry
-> IO ()
Visit each entry in a directory at a URI, calling a DirectoryVisitCallback for each one.
directoryVisitFilesSource
:: TextURItextURI - string representation of the URI of the directory to visit
-> [String]files - the files contained in textURI to be visited
-> [FileInfoOptions]infoOptions - options for reading file information
-> [DirectoryVisitOptions]visitOptions - options for visiting the directory
-> DirectoryVisitCallbackcallback - a function to be called for each entry
-> IO ()
Visit each file in a list contained with a directory at a TextURI, calling a DirectoryVisitCallback for each one.
directoryVisitFilesAtURISource
:: URIuri - the URI of the directory to visit
-> [String]files - the files contained in textURI to be visited
-> [FileInfoOptions]infoOptions - options for reading file information
-> [DirectoryVisitOptions]visitOptions - options for visiting the directory
-> DirectoryVisitCallbackcallback - a function to be called for each entry
-> IO ()
Visit each file in a list contained with a directory at a URI, calling a DirectoryVisitCallback for each one.
Produced by Haddock version 2.6.1