-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Use RawFilePath instead of FilePath
--   
--   Please see README.md
@package rawfilepath
@version 0.1.0.0


-- | Higher-level API for the <a>RawFilePath</a>-variants of functions in
--   the <tt>unix</tt> module.
module System.RawFilePath

-- | A literal POSIX file path
type RawFilePath = ByteString

-- | Creates a new process to run the specified command with the given
--   arguments, and waits for it to finish. Throws an exception if the
--   process returns a nonzero exit code.
--   
--   <pre>
--   *System.RawFilePath&gt; callProcess "ls" ["-a", "src"]
--   .  ..  System
--   </pre>
callProcess :: RawFilePath -> [ByteString] -> IO ()

-- | Same as <a>callProcess</a> except the child process will share the
--   parent's stdout and stderr, meaning it won't print anything.
callProcessSilent :: RawFilePath -> [ByteString] -> IO ExitCode

-- | Runs a command, reads its standard output strictly, blocking until the
--   process terminates, and returns the output as <a>ByteString</a>.
--   
--   <pre>
--   *System.RawFilePath&gt; readProcess "date" ["+%s"]
--   "1469999314\n"
--   </pre>
readProcess :: RawFilePath -> [ByteString] -> IO ByteString

-- | A 'safer' approach to <a>readProcess</a>. Depending on the exit status
--   of the process, this function will return output either from stderr or
--   stdout.
--   
--   <pre>
--   *System.RawFilePath&gt; readProcessEither "date" ["%s"]
--   Left "date: invalid date \226\128\152%s\226\128\153\n"
--   *System.RawFilePath&gt; readProcessEither "date" ["+%s"]
--   Right "1469999817\n"
--   </pre>
readProcessEither :: RawFilePath -> [ByteString] -> IO (Either ByteString ByteString)

-- | Get a list of files in the specified directory, excluding "." and ".."
--   
--   <pre>
--   *System.RawFilePath&gt; listDirectory "src"
--   ["..","System","."]
--   </pre>
listDirectory :: RawFilePath -> IO [RawFilePath]

-- | Get a list of files in the specified directory, including "." and ".."
--   
--   <pre>
--   *System.RawFilePath&gt; getDirectoryFiles "src"
--   ["..","System","."]
--   </pre>
getDirectoryFiles :: RawFilePath -> IO [RawFilePath]

-- | Recursively get all files in all subdirectories of the specified
--   directory.
--   
--   <pre>
--   *System.RawFilePath&gt; getDirectoryFilesRecursive "src"
--   ["src/System/RawFilePath.hs"]
--   </pre>
getDirectoryFilesRecursive :: RawFilePath -> IO [RawFilePath]

-- | Copy a file from the source path to the destination path.
copyFile :: RawFilePath -> RawFilePath -> IO ()

-- | Returns the current user's home directory.
getHomeDirectory :: IO RawFilePath

-- | Returns <a>True</a> if the argument file exists and is not a
--   directory.
doesFileExist :: RawFilePath -> IO Bool

-- | Returns <a>True</a> if the argument file exists and is a directory.
doesDirectoryExist :: RawFilePath -> IO Bool

-- | Change the working directory to the given path.
setCurrentDirectory :: RawFilePath -> IO ()

-- | A function that "tries" to remove a file. If the file does not exist,
--   nothing happens.
tryRemoveFile :: RawFilePath -> IO ()


-- | A variant of <tt>Data.ByteString</tt> from the <tt>bytestring</tt>
--   package that provides file I/O functions with <a>RawFilePath</a>
--   instead of <a>FilePath</a>.
module Data.ByteString.RawFilePath

-- | A literal POSIX file path
type RawFilePath = ByteString

-- | Read an entire file at the <a>RawFilePath</a> strictly into a
--   <a>ByteString</a>.
readFile :: RawFilePath -> IO ByteString

-- | Write a <a>ByteString</a> to a file at the <a>RawFilePath</a>.
writeFile :: RawFilePath -> ByteString -> IO ()

-- | Append a <a>ByteString</a> to a file at the <a>RawFilePath</a>.
appendFile :: RawFilePath -> ByteString -> IO ()

-- | Acquire a file handle and perform an I/O action. The file will be
--   closed on exit or when this I/O action throws an exception.
withFile :: RawFilePath -> IOMode -> (Handle -> IO r) -> IO r