9 lines
18 KiB
HTML
9 lines
18 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.Posix.Directory.Foreign</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
|
|
window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-Directory-Foreign.html");};
|
|
//]]>
|
|
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/System-Posix-Directory-Foreign.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">hpath-0.7.3: Support for well-typed paths</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">System.Posix.Directory.Foreign</p></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"><span class="keyword">newtype</span> <a href="#t:DirType">DirType</a> = <a href="#v:DirType">DirType</a> Int</li><li class="src short"><span class="keyword">data</span> <a href="#t:Flags">Flags</a><ul class="subs"><li>= <a href="#v:Flags">Flags</a> Int</li><li>| <a href="#v:UnsupportedFlag">UnsupportedFlag</a> String</li></ul></li><li class="src short"><a href="#v:unFlags">unFlags</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> Int</li><li class="src short"><a href="#v:isSupported">isSupported</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> Bool</li><li class="src short"><a href="#v:oCloexec">oCloexec</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:dtBlk">dtBlk</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></li><li class="src short"><a href="#v:oAppend">oAppend</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:dtChr">dtChr</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></li><li class="src short"><a href="#v:pathMax">pathMax</a> :: Int</li><li class="src short"><a href="#v:oAsync">oAsync</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:dtDir">dtDir</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></li><li class="src short"><a href="#v:oCreat">oCreat</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:dtFifo">dtFifo</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></li><li class="src short"><a href="#v:unionFlags">unionFlags</a> :: [<a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a>] -> CInt</li><li class="src short"><a href="#v:dtLnk">dtLnk</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></li><li class="src short"><a href="#v:oDirectory">oDirectory</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:oExcl">oExcl</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:dtReg">dtReg</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></li><li class="src short"><a href="#v:oNoctty">oNoctty</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:dtSock">dtSock</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></li><li class="src short"><a href="#v:oNofollow">oNofollow</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:dtUnknown">dtUnknown</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></li><li class="src short"><a href="#v:oNonblock">oNonblock</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:oRdonly">oRdonly</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:oWronly">oWronly</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:oRdwr">oRdwr</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:oSync">oSync</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li><li class="src short"><a href="#v:oTrunc">oTrunc</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">newtype</span> <a id="t:DirType" class="def">DirType</a> <a href="src/System-Posix-Directory-Foreign.html#DirType" class="link">Source</a> <a href="#t:DirType" class="selflink">#</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:DirType" class="def">DirType</a> Int</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:DirType" class="caption collapser" onclick="toggleSection('i:DirType')">Instances</p><div id="section.i:DirType" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:DirType:Eq:1" class="instance expander" onclick="toggleSection('i:id:DirType:Eq:1')"></span> Eq <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></span> <a href="src/System-Posix-Directory-Foreign.html#line-14" class="link">Source</a> <a href="#t:DirType" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:DirType:Eq:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> -> <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> -> Bool</p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> -> <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> -> Bool</p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:DirType:Show:2" class="instance expander" onclick="toggleSection('i:id:DirType:Show:2')"></span> Show <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a></span> <a href="src/System-Posix-Directory-Foreign.html#line-14" class="link">Source</a> <a href="#t:DirType" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:DirType:Show:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: Int -> <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> -> ShowS</p><p class="src"><a href="#v:show">show</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> -> String</p><p class="src"><a href="#v:showList">showList</a> :: [<a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a>] -> ShowS</p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Flags" class="def">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#Flags" class="link">Source</a> <a href="#t:Flags" class="selflink">#</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Flags" class="def">Flags</a> Int</td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:UnsupportedFlag" class="def">UnsupportedFlag</a> String</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Flags" class="caption collapser" onclick="toggleSection('i:Flags')">Instances</p><div id="section.i:Flags" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Flags:Eq:1" class="instance expander" onclick="toggleSection('i:id:Flags:Eq:1')"></span> Eq <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></span> <a href="src/System-Posix-Directory-Foreign.html#line-15" class="link">Source</a> <a href="#t:Flags" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Flags:Eq:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> Bool</p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> Bool</p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Flags:Show:2" class="instance expander" onclick="toggleSection('i:id:Flags:Show:2')"></span> Show <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a></span> <a href="src/System-Posix-Directory-Foreign.html#line-15" class="link">Source</a> <a href="#t:Flags" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Flags:Show:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: Int -> <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> ShowS</p><p class="src"><a href="#v:show">show</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> String</p><p class="src"><a href="#v:showList">showList</a> :: [<a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a>] -> ShowS</p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:unFlags" class="def">unFlags</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> Int <a href="src/System-Posix-Directory-Foreign.html#unFlags" class="link">Source</a> <a href="#v:unFlags" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:isSupported" class="def">isSupported</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> -> Bool <a href="src/System-Posix-Directory-Foreign.html#isSupported" class="link">Source</a> <a href="#v:isSupported" class="selflink">#</a></p><div class="doc"><p>Returns <code>True</code> if posix-paths was compiled with support for the provided
|
|
flag. (As of this writing, the only flag for which this check may be
|
|
necessary is <code><a href="System-Posix-Directory-Foreign.html#v:oCloexec">oCloexec</a></code>; all other flags will always yield <code>True</code>.)</p></div></div><div class="top"><p class="src"><a id="v:oCloexec" class="def">oCloexec</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oCloexec" class="link">Source</a> <a href="#v:oCloexec" class="selflink">#</a></p><div class="doc"><p><code>O_CLOEXEC</code> is not supported on every POSIX platform. Use
|
|
<code><code><a href="System-Posix-Directory-Foreign.html#v:isSupported">isSupported</a></code> oCloexec</code> to determine if support for <code>O_CLOEXEC</code> was
|
|
compiled into your version of posix-paths. (If not, using <code>oCloexec</code> will
|
|
throw an exception.)</p></div></div><div class="top"><p class="src"><a id="v:dtBlk" class="def">dtBlk</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> <a href="src/System-Posix-Directory-Foreign.html#dtBlk" class="link">Source</a> <a href="#v:dtBlk" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oAppend" class="def">oAppend</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oAppend" class="link">Source</a> <a href="#v:oAppend" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:dtChr" class="def">dtChr</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> <a href="src/System-Posix-Directory-Foreign.html#dtChr" class="link">Source</a> <a href="#v:dtChr" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:pathMax" class="def">pathMax</a> :: Int <a href="src/System-Posix-Directory-Foreign.html#pathMax" class="link">Source</a> <a href="#v:pathMax" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oAsync" class="def">oAsync</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oAsync" class="link">Source</a> <a href="#v:oAsync" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:dtDir" class="def">dtDir</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> <a href="src/System-Posix-Directory-Foreign.html#dtDir" class="link">Source</a> <a href="#v:dtDir" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oCreat" class="def">oCreat</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oCreat" class="link">Source</a> <a href="#v:oCreat" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:dtFifo" class="def">dtFifo</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> <a href="src/System-Posix-Directory-Foreign.html#dtFifo" class="link">Source</a> <a href="#v:dtFifo" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:unionFlags" class="def">unionFlags</a> :: [<a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a>] -> CInt <a href="src/System-Posix-Directory-Foreign.html#unionFlags" class="link">Source</a> <a href="#v:unionFlags" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:dtLnk" class="def">dtLnk</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> <a href="src/System-Posix-Directory-Foreign.html#dtLnk" class="link">Source</a> <a href="#v:dtLnk" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oDirectory" class="def">oDirectory</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oDirectory" class="link">Source</a> <a href="#v:oDirectory" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oExcl" class="def">oExcl</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oExcl" class="link">Source</a> <a href="#v:oExcl" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:dtReg" class="def">dtReg</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> <a href="src/System-Posix-Directory-Foreign.html#dtReg" class="link">Source</a> <a href="#v:dtReg" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oNoctty" class="def">oNoctty</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oNoctty" class="link">Source</a> <a href="#v:oNoctty" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:dtSock" class="def">dtSock</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> <a href="src/System-Posix-Directory-Foreign.html#dtSock" class="link">Source</a> <a href="#v:dtSock" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oNofollow" class="def">oNofollow</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oNofollow" class="link">Source</a> <a href="#v:oNofollow" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:dtUnknown" class="def">dtUnknown</a> :: <a href="System-Posix-Directory-Foreign.html#t:DirType">DirType</a> <a href="src/System-Posix-Directory-Foreign.html#dtUnknown" class="link">Source</a> <a href="#v:dtUnknown" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oNonblock" class="def">oNonblock</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oNonblock" class="link">Source</a> <a href="#v:oNonblock" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oRdonly" class="def">oRdonly</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oRdonly" class="link">Source</a> <a href="#v:oRdonly" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oWronly" class="def">oWronly</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oWronly" class="link">Source</a> <a href="#v:oWronly" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oRdwr" class="def">oRdwr</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oRdwr" class="link">Source</a> <a href="#v:oRdwr" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oSync" class="def">oSync</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oSync" class="link">Source</a> <a href="#v:oSync" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:oTrunc" class="def">oTrunc</a> :: <a href="System-Posix-Directory-Foreign.html#t:Flags">Flags</a> <a href="src/System-Posix-Directory-Foreign.html#oTrunc" class="link">Source</a> <a href="#v:oTrunc" class="selflink">#</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html> |