<!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.Posix.Directory.ByteString</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-Posix-Directory-ByteString.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">unix-2.5.1.1: POSIX functionality</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>non-portable (requires POSIX)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>libraries@haskell.org</td></tr><tr><th>Safe Haskell</th><td>Trustworthy</td></tr></table><p class="caption">System.Posix.Directory.ByteString</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Creating and removing directories </a></li><li><a href="#g:2">Reading directories </a></li><li><a href="#g:3">The working dirctory </a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>String-based POSIX directory support </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:createDirectory">createDirectory</a> :: <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a> -> <a href="../base-4.5.1.0/System-Posix-Types.html#t:FileMode">FileMode</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:removeDirectory">removeDirectory</a> :: <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><span class="keyword">data</span> <a href="#t:DirStream">DirStream</a> </li><li class="src short"><a href="#v:openDirStream">openDirStream</a> :: <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a></li><li class="src short"><a href="#v:readDirStream">readDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a></li><li class="src short"><a href="#v:rewindDirStream">rewindDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:closeDirStream">closeDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><span class="keyword">data</span> <a href="#t:DirStreamOffset">DirStreamOffset</a> </li><li class="src short"><a href="#v:tellDirStream">tellDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="System-Posix-Directory-ByteString.html#t:DirStreamOffset">DirStreamOffset</a></li><li class="src short"><a href="#v:seekDirStream">seekDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="System-Posix-Directory-ByteString.html#t:DirStreamOffset">DirStreamOffset</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:getWorkingDirectory">getWorkingDirectory</a> :: <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a></li><li class="src short"><a href="#v:changeWorkingDirectory">changeWorkingDirectory</a> :: <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:changeWorkingDirectoryFd">changeWorkingDirectoryFd</a> :: <a href="../base-4.5.1.0/System-Posix-Types.html#t:Fd">Fd</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li></ul></div><div id="interface"><h1 id="g:1">Creating and removing directories </h1><div class="top"><p class="src"><a name="v:createDirectory" class="def">createDirectory</a> :: <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a> -> <a href="../base-4.5.1.0/System-Posix-Types.html#t:FileMode">FileMode</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p><div class="doc"><p><code>createDirectory dir mode</code> calls <code>mkdir</code> to create a new directory, <code>dir</code>, with permissions based on <code>mode</code>. </p></div></div><div class="top"><p class="src"><a name="v:removeDirectory" class="def">removeDirectory</a> :: <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><h1 id="g:2">Reading directories </h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DirStream" class="def">DirStream</a> </p></div><div class="top"><p class="src"><a name="v:openDirStream" class="def">openDirStream</a> :: <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a></p><div class="doc"><p><code>openDirStream dir</code> calls <code>opendir</code> to obtain a directory stream for <code>dir</code>. </p></div></div><div class="top"><p class="src"><a name="v:readDirStream" class="def">readDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a></p><div class="doc"><p><code>readDirStream dp</code> calls <code>readdir</code> to obtain the next directory entry (<code>struct dirent</code>) for the open directory stream <code>dp</code>, and returns the <code>d_name</code> member of that structure. </p></div></div><div class="top"><p class="src"><a name="v:rewindDirStream" class="def">rewindDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p><div class="doc"><p><code>rewindDirStream dp</code> calls <code>rewinddir</code> to reposition the directory stream <code>dp</code> at the beginning of the directory. </p></div></div><div class="top"><p class="src"><a name="v:closeDirStream" class="def">closeDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p><div class="doc"><p><code>closeDirStream dp</code> calls <code>closedir</code> to close the directory stream <code>dp</code>. </p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DirStreamOffset" class="def">DirStreamOffset</a> </p></div><div class="top"><p class="src"><a name="v:tellDirStream" class="def">tellDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="System-Posix-Directory-ByteString.html#t:DirStreamOffset">DirStreamOffset</a></p></div><div class="top"><p class="src"><a name="v:seekDirStream" class="def">seekDirStream</a> :: <a href="System-Posix-Directory-ByteString.html#t:DirStream">DirStream</a> -> <a href="System-Posix-Directory-ByteString.html#t:DirStreamOffset">DirStreamOffset</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><h1 id="g:3">The working dirctory </h1><div class="top"><p class="src"><a name="v:getWorkingDirectory" class="def">getWorkingDirectory</a> :: <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a></p><div class="doc"><p><code>getWorkingDirectory</code> calls <code>getcwd</code> to obtain the name of the current working directory. </p></div></div><div class="top"><p class="src"><a name="v:changeWorkingDirectory" class="def">changeWorkingDirectory</a> :: <a href="System-Posix-ByteString-FilePath.html#t:RawFilePath">RawFilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p><div class="doc"><p><code>changeWorkingDirectory dir</code> calls <code>chdir</code> to change the current working directory to <code>dir</code>. </p></div></div><div class="top"><p class="src"><a name="v:changeWorkingDirectoryFd" class="def">changeWorkingDirectoryFd</a> :: <a href="../base-4.5.1.0/System-Posix-Types.html#t:Fd">Fd</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>