hark-0.2: html/Parsers-Content.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Parsers.Content</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Parsers-Content.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Parsers.Content</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>this module parses the contents of a package and
puts everything into a list of PackageContent data
structures
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3AdefaultContent"
>defaultContent</A
> :: <A HREF="Parsers-Content.html#t%3APackageContentItem"
>PackageContentItem</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aget_content"
>get_content</A
> :: FilePath -> IO ByteString</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A HREF="#t%3AFileType"
>FileType</A
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ANone"
>None</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ADir"
>Dir</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ASym"
>Sym</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AObj"
>Obj</A
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A HREF="#t%3APackageContentItem"
>PackageContentItem</A
> = <A HREF="#v%3APackageContentItem"
>PackageContentItem</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AfileType"
>fileType</A
> :: <A HREF="Parsers-Content.html#t%3AFileType"
>FileType</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Aname"
>name</A
> :: ByteString</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Amd5"
>md5</A
> :: ByteString</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Asize"
>size</A
> :: ByteString</TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aretrieve_package_content"
>retrieve_package_content</A
> :: FilePath -> IO [<A HREF="Parsers-Content.html#t%3APackageContentItem"
>PackageContentItem</A
>]</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:defaultContent"
><A NAME="v%3AdefaultContent"
></A
></A
><B
>defaultContent</B
> :: <A HREF="Parsers-Content.html#t%3APackageContentItem"
>PackageContentItem</A
></TD
></TR
><TR
><TD CLASS="doc"
>default Dependency data structure
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:get_content"
><A NAME="v%3Aget_content"
></A
></A
><B
>get_content</B
> :: FilePath -> IO ByteString</TD
></TR
><TR
><TD CLASS="doc"
>read the CONTENT of a file and return it as a raw
ByteString
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A NAME="t:FileType"
><A NAME="t%3AFileType"
></A
></A
><B
>FileType</B
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>data type for describing the type of <A HREF="file.html"
>file</A
>
in the PackageContent
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:None"
><A NAME="v%3ANone"
></A
></A
><B
>None</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Dir"
><A NAME="v%3ADir"
></A
></A
><B
>Dir</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Sym"
><A NAME="v%3ASym"
></A
></A
><B
>Sym</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Obj"
><A NAME="v%3AObj"
></A
></A
><B
>Obj</B
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:FileType')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:FileType" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Eq <A HREF="Parsers-Content.html#t%3AFileType"
>FileType</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A NAME="t:PackageContentItem"
><A NAME="t%3APackageContentItem"
></A
></A
><B
>PackageContentItem</B
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>data structure for holding a single entry in the
CONTENTS file of a package
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:PackageContentItem"
><A NAME="v%3APackageContentItem"
></A
></A
><B
>PackageContentItem</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:fileType"
><A NAME="v%3AfileType"
></A
></A
><B
>fileType</B
> :: <A HREF="Parsers-Content.html#t%3AFileType"
>FileType</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:name"
><A NAME="v%3Aname"
></A
></A
><B
>name</B
> :: ByteString</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:md5"
><A NAME="v%3Amd5"
></A
></A
><B
>md5</B
> :: ByteString</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:size"
><A NAME="v%3Asize"
></A
></A
><B
>size</B
> :: ByteString</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:PackageContentItem')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:PackageContentItem" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Eq <A HREF="Parsers-Content.html#t%3APackageContentItem"
>PackageContentItem</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:retrieve_package_content"
><A NAME="v%3Aretrieve_package_content"
></A
></A
><B
>retrieve_package_content</B
> :: FilePath -> IO [<A HREF="Parsers-Content.html#t%3APackageContentItem"
>PackageContentItem</A
>]</TD
></TR
><TR
><TD CLASS="doc"
>retrieve content of package located at location path
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.4.2</TD
></TR
></TABLE
></BODY
></HTML
>