<!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>Darcs.Repository.Format</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_Darcs-Repository-Format.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Darcs-Repository-Format.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">darcs-2.8.3: a distributed, interactive, smart revision control system</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Darcs.Repository.Format</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:RepoFormat">RepoFormat</a> = <a href="#v:RF">RF</a> [[<a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a>]]</li><li class="src short"><span class="keyword">data</span> <a href="#t:RepoProperty">RepoProperty</a> <ul class="subs"><li>= <a href="#v:Darcs1_0">Darcs1_0</a> </li><li>| <a href="#v:Darcs2">Darcs2</a> </li><li>| <a href="#v:HashedInventory">HashedInventory</a> </li><li>| <a href="#v:NoWorkingDir">NoWorkingDir</a> </li></ul></li><li class="src short"><a href="#v:identifyRepoFormat">identifyRepoFormat</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a></li><li class="src short"><a href="#v:tryIdentifyRepoFormat">tryIdentifyRepoFormat</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a>)</li><li class="src short"><a href="#v:createRepoFormat">createRepoFormat</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a></li><li class="src short"><a href="#v:writeRepoFormat">writeRepoFormat</a> :: <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:writeProblem">writeProblem</a> :: <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:readProblem">readProblem</a> :: <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:readfromAndWritetoProblem">readfromAndWritetoProblem</a> :: <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:formatHas">formatHas</a> :: <a href="Darcs-Repository-Format.html#t:RepoProperty">RepoProperty</a> -> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:RepoFormat" class="def">RepoFormat</a> <a href="src/Darcs-Repository-Format.html#RepoFormat" class="link">Source</a></p><div class="doc"><p><code>RepoFormat</code> is the representation of the format of a
repository. Each sublist corresponds to a line in the format
file. Each line is decomposed into words.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:RF" class="def">RF</a> [[<a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a>]]</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:RepoFormat" class="caption collapser" onclick="toggleSection('i:RepoFormat')">Instances</p><div id="section.i:RepoFormat" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:RepoProperty" class="def">RepoProperty</a> <a href="src/Darcs-Repository-Format.html#RepoProperty" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Darcs1_0" class="def">Darcs1_0</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Darcs2" class="def">Darcs2</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:HashedInventory" class="def">HashedInventory</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:NoWorkingDir" class="def">NoWorkingDir</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:RepoProperty" class="caption collapser" onclick="toggleSection('i:RepoProperty')">Instances</p><div id="section.i:RepoProperty" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Darcs-Repository-Format.html#t:RepoProperty">RepoProperty</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:identifyRepoFormat" class="def">identifyRepoFormat</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a><a href="src/Darcs-Repository-Format.html#identifyRepoFormat" class="link">Source</a></p><div class="doc"><p><code>identifyRepoFormat URL</code> identifies the format of the repository
at the given address. Fails if we weren't able to identify the format.
</p></div></div><div class="top"><p class="src"><a name="v:tryIdentifyRepoFormat" class="def">tryIdentifyRepoFormat</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a>)<a href="src/Darcs-Repository-Format.html#tryIdentifyRepoFormat" class="link">Source</a></p><div class="doc"><p><code>tryIdentifyRepoFormat URL</code> identifies the format of the repository
at the given address. Return <code>Left reason</code> if it fails, where
<code>reason</code> explains why we weren't able to identify the format.
</p></div></div><div class="top"><p class="src"><a name="v:createRepoFormat" class="def">createRepoFormat</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a><a href="src/Darcs-Repository-Format.html#createRepoFormat" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:writeRepoFormat" class="def">writeRepoFormat</a> :: <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Darcs-Repository-Format.html#writeRepoFormat" class="link">Source</a></p><div class="doc"><p><code>writeRepoFormat</code> writes the repo format to the given file.
</p></div></div><div class="top"><p class="src"><a name="v:writeProblem" class="def">writeProblem</a> :: <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Repository-Format.html#writeProblem" class="link">Source</a></p><div class="doc"><p><code>writeProblem form</code> tells if we can write to a repo in format <code>form</code>.
It returns <code>Nothing</code> if there's no problem writing to such a repository.
</p></div></div><div class="top"><p class="src"><a name="v:readProblem" class="def">readProblem</a> :: <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Repository-Format.html#readProblem" class="link">Source</a></p><div class="doc"><p><code>readProblem form</code> tells if we can read from a repo in format <code>form</code>.
It returns <code>Nothing</code> if there's no problem reading from such a repository.
</p></div></div><div class="top"><p class="src"><a name="v:readfromAndWritetoProblem" class="def">readfromAndWritetoProblem</a> :: <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Repository-Format.html#readfromAndWritetoProblem" class="link">Source</a></p><div class="doc"><p><code>readfromAndWritetoProblem form</code> tells if we can read from and write to a repo in
format <code>form</code>. It returns <code>Nothing</code> if there's no problem reading
and writing to such a repository.
</p></div></div><div class="top"><p class="src"><a name="v:formatHas" class="def">formatHas</a> :: <a href="Darcs-Repository-Format.html#t:RepoProperty">RepoProperty</a> -> <a href="Darcs-Repository-Format.html#t:RepoFormat">RepoFormat</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Darcs-Repository-Format.html#formatHas" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
