14 lines
7.6 KiB
HTML
14 lines
7.6 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>System.IO.HVFS.Utils</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
|
|
window.onload = function () {pageLoad();setSynopsis("mini_System-IO-HVFS-Utils.html");};
|
|
//]]>
|
|
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">MissingH-1.3.0.1: Large utility library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>Copyright (C) 2004-2011 John Goerzen</td></tr><tr><th>License</th><td>BSD3</td></tr><tr><th>Maintainer</th><td>John Goerzen <jgoerzen@complete.org> </td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">System.IO.HVFS.Utils</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module provides various helpful utilities for dealing
|
|
filesystems.</p><p>Written by John Goerzen, jgoerzen@complete.org</p><p>To operate on your system's main filesystem, just pass SystemFS as the
|
|
first parameter to these functions.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:recurseDir">recurseDir</a> :: <a href="System-IO-HVFS.html#t:HVFS">HVFS</a> a => a -> <a href="System-IO-HVFS.html#t:FilePath">FilePath</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [<a href="System-IO-HVFS.html#t:FilePath">FilePath</a>]</li><li class="src short"><a href="#v:recurseDirStat">recurseDirStat</a> :: <a href="System-IO-HVFS.html#t:HVFS">HVFS</a> a => a -> <a href="System-IO-HVFS.html#t:FilePath">FilePath</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [(<a href="System-IO-HVFS.html#t:FilePath">FilePath</a>, <a href="System-IO-HVFS.html#t:HVFSStatEncap">HVFSStatEncap</a>)]</li><li class="src short"><a href="#v:recursiveRemove">recursiveRemove</a> :: <a href="System-IO-HVFS.html#t:HVFS">HVFS</a> a => a -> <a href="System-IO-HVFS.html#t:FilePath">FilePath</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:lsl">lsl</a> :: <a href="System-IO-HVFS.html#t:HVFS">HVFS</a> a => a -> <a href="System-IO-HVFS.html#t:FilePath">FilePath</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:SystemFS">SystemFS</a> = <a href="#v:SystemFS">SystemFS</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:recurseDir" class="def">recurseDir</a> :: <a href="System-IO-HVFS.html#t:HVFS">HVFS</a> a => a -> <a href="System-IO-HVFS.html#t:FilePath">FilePath</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [<a href="System-IO-HVFS.html#t:FilePath">FilePath</a>]</p><div class="doc"><p>Obtain a recursive listing of all files/directories beneath
|
|
the specified directory. The traversal is depth-first
|
|
and the original
|
|
item is always present in the returned list.</p><p>If the passed value is not a directory, the return value
|
|
be only that value.</p><p>The "." and ".." entries are removed from the data returned.</p></div></div><div class="top"><p class="src"><a name="v:recurseDirStat" class="def">recurseDirStat</a> :: <a href="System-IO-HVFS.html#t:HVFS">HVFS</a> a => a -> <a href="System-IO-HVFS.html#t:FilePath">FilePath</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> [(<a href="System-IO-HVFS.html#t:FilePath">FilePath</a>, <a href="System-IO-HVFS.html#t:HVFSStatEncap">HVFSStatEncap</a>)]</p><div class="doc"><p>Like <code><a href="System-IO-HVFS-Utils.html#v:recurseDir">recurseDir</a></code>, but return the stat() (System.Posix.Files.FileStatus)
|
|
information with them. This is an optimization if you will be statting files
|
|
yourself later.</p><p>The items are returned lazily.</p><p>WARNING: do not change your current working directory until you have consumed
|
|
all the items. Doing so could cause strange effects.</p><p>Alternatively, you may wish to pass an absolute path to this function.</p></div></div><div class="top"><p class="src"><a name="v:recursiveRemove" class="def">recursiveRemove</a> :: <a href="System-IO-HVFS.html#t:HVFS">HVFS</a> a => a -> <a href="System-IO-HVFS.html#t:FilePath">FilePath</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> ()</p><div class="doc"><p>Removes a file or a directory. If a directory, also removes all its
|
|
child files/directories.</p></div></div><div class="top"><p class="src"><a name="v:lsl" class="def">lsl</a> :: <a href="System-IO-HVFS.html#t:HVFS">HVFS</a> a => a -> <a href="System-IO-HVFS.html#t:FilePath">FilePath</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a></p><div class="doc"><p>Provide a result similar to the command ls -l over a directory.</p><p>Known bug: setuid bit semantics are inexact compared with standard ls.</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:SystemFS" class="def">SystemFS</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:SystemFS" class="def">SystemFS</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:SystemFS" class="caption collapser" onclick="toggleSection('i:SystemFS')">Instances</p><div id="section.i:SystemFS" class="show"><table><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="System-IO-HVFS-Utils.html#t:SystemFS">SystemFS</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> <a href="System-IO-HVFS-Utils.html#t:SystemFS">SystemFS</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="System-IO-HVFS.html#t:HVFSOpenable">HVFSOpenable</a> <a href="System-IO-HVFS-Utils.html#t:SystemFS">SystemFS</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="System-IO-HVFS.html#t:HVFS">HVFS</a> <a href="System-IO-HVFS-Utils.html#t:SystemFS">SystemFS</a></td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.0</p></div></body></html> |