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


-- | URI template library for Haskell
--   
--   A URI template expansion library for Haskell. Provides support for Joe
--   Gregorio's standardized format, OpenSearch 1.1's format +
--   WADL/WSDL-style templates.
@package uri-template
@version 0.2


-- | URI templates and their expansion. For details (and up-to-date specs),
--   see http:<i></i>bitworking.org<i>projects</i>
--   
--   Also implements the OpenSearch 1.1 style with <tt>?</tt> suffix chars
--   + support for namespace prefixes {xmlns:foo?} =&gt; xmlns:bar
module Network.URI.Template

-- | <tt>TemplateEnv</tt> holds the key,value mapping for the expansion
--   context for a URI template.
data TemplateEnv

-- | Construct a new, empty <a>TemplateEnv</a>.
newEnv :: TemplateEnv

-- | <tt>addToEnv key value env</tt> augments <tt>env</tt> with a new
--   key,value pair.
addToEnv :: String -> String -> TemplateEnv -> TemplateEnv

-- | <tt>addListToEnv key vals env</tt> expands the template environment
--   <tt>env</tt> with a list-valued key,value(s) pair.
addListToEnv :: String -> [String] -> TemplateEnv -> TemplateEnv
type URITemplate = String
type URIString = String

-- | <tt>expand tenv tpl</tt> performs template expansion on URL template
--   <tt>tpl</tt> wrt <tt>tenv</tt>. The result contains the expansion,
--   _but_ leaving unbound template variables intact.
expand :: TemplateEnv -> URITemplate -> URIString