<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Ocsigen_http_com.html">
<link rel="next" href="Ocsigen_senders.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Ocsigen_cache" rel="Chapter" href="Ocsigen_cache.html">
<link title="Ocsigen_lib_base" rel="Chapter" href="Ocsigen_lib_base.html">
<link title="Ocsigen_lib" rel="Chapter" href="Ocsigen_lib.html">
<link title="Ocsigen_config" rel="Chapter" href="Ocsigen_config.html">
<link title="Ocsigen_getcommandline" rel="Chapter" href="Ocsigen_getcommandline.html">
<link title="Ocsigen_messages" rel="Chapter" href="Ocsigen_messages.html">
<link title="Ocsigen_stream" rel="Chapter" href="Ocsigen_stream.html">
<link title="Ocsigen_loader" rel="Chapter" href="Ocsigen_loader.html">
<link title="Polytables" rel="Chapter" href="Polytables.html">
<link title="Http_headers" rel="Chapter" href="Http_headers.html">
<link title="Ocsigen_http_frame" rel="Chapter" href="Ocsigen_http_frame.html">
<link title="Ocsigen_headers" rel="Chapter" href="Ocsigen_headers.html">
<link title="Framepp" rel="Chapter" href="Framepp.html">
<link title="Ocsigen_http_com" rel="Chapter" href="Ocsigen_http_com.html">
<link title="Ocsigen_charset_mime" rel="Chapter" href="Ocsigen_charset_mime.html">
<link title="Ocsigen_senders" rel="Chapter" href="Ocsigen_senders.html">
<link title="Ocsigen_cookies" rel="Chapter" href="Ocsigen_cookies.html">
<link title="Ocsigen_extensions" rel="Chapter" href="Ocsigen_extensions.html">
<link title="Ocsigen_parseconfig" rel="Chapter" href="Ocsigen_parseconfig.html">
<link title="Ocsigen_http_client" rel="Chapter" href="Ocsigen_http_client.html">
<link title="Ocsigen_local_files" rel="Chapter" href="Ocsigen_local_files.html">
<link title="Ocsigen_server" rel="Chapter" href="Ocsigen_server.html">
<link title="Ocsigen_comet" rel="Chapter" href="Ocsigen_comet.html">
<link title="Accesscontrol" rel="Chapter" href="Accesscontrol.html">
<link title="Authbasic" rel="Chapter" href="Authbasic.html">
<link title="Ocsipersist" rel="Chapter" href="Ocsipersist.html"><title>Ocsigen_charset_mime</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Ocsigen_http_com.html" title="Ocsigen_http_com">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Ocsigen_senders.html" title="Ocsigen_senders">Next</a>
</div>
<h1>Module <a href="type_Ocsigen_charset_mime.html">Ocsigen_charset_mime</a></h1>
<pre><span class="keyword">module</span> Ocsigen_charset_mime: <code class="code">sig</code> <a href="Ocsigen_charset_mime.html">..</a> <code class="code">end</code></pre><div class="info module top">
Charset<br>
</div>
<hr width="100%">
<pre><span id="TYPEextension"><span class="keyword">type</span> <code class="type"></code>extension</span> = <code class="type">string</code> </pre>
<pre><span id="TYPEfile"><span class="keyword">type</span> <code class="type"></code>file</span> = <code class="type">string</code> </pre>
<pre><span id="TYPEfilename"><span class="keyword">type</span> <code class="type"></code>filename</span> = <code class="type">string</code> </pre>
<br>
Charset<br>
<pre><span id="TYPEcharset"><span class="keyword">type</span> <code class="type"></code>charset</span> = <code class="type">string</code> </pre>
<div class="info ">
By convention, "no specified charset" is represented by the empty
string<br>
</div>
<pre><span id="VALno_charset"><span class="keyword">val</span> no_charset</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEcharset">charset</a></code></pre>
<pre><span id="TYPEcharset_assoc"><span class="keyword">type</span> <code class="type"></code>charset_assoc</span> </pre>
<div class="info ">
Association between extensions and charset, with a default value.<br>
</div>
<pre><span id="VALempty_charset_assoc"><span class="keyword">val</span> empty_charset_assoc</span> : <code class="type">?default:<a href="Ocsigen_charset_mime.html#TYPEcharset">charset</a> -><br> unit -> <a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a></code></pre><div class="info ">
All files are mapped to <code class="code">no_charset</code><br>
</div>
<pre><span id="VALfind_charset"><span class="keyword">val</span> find_charset</span> : <code class="type">string -> <a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a> -> <a href="Ocsigen_charset_mime.html#TYPEcharset">charset</a></code></pre>
<pre><span id="VALdefault_charset"><span class="keyword">val</span> default_charset</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a> -> <a href="Ocsigen_charset_mime.html#TYPEcharset">charset</a></code></pre><div class="info ">
Functions related to the default charset in the association<br>
</div>
<pre><span id="VALset_default_charset"><span class="keyword">val</span> set_default_charset</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEcharset">charset</a> -> <a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a></code></pre>
<pre><span id="VALupdate_charset_ext"><span class="keyword">val</span> update_charset_ext</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEextension">extension</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEcharset">charset</a> -> <a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a></code></pre><div class="info ">
Updates the mapping between extensions from a file to its charset.
The update can be specified using the extension of the file,
the name of the file, or the entire file (with its path)<br>
</div>
<pre><span id="VALupdate_charset_file"><span class="keyword">val</span> update_charset_file</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEfilename">filename</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEcharset">charset</a> -> <a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a></code></pre>
<pre><span id="VALupdate_charset_regexp"><span class="keyword">val</span> update_charset_regexp</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a> -><br> Netstring_pcre.regexp -><br> <a href="Ocsigen_charset_mime.html#TYPEcharset">charset</a> -> <a href="Ocsigen_charset_mime.html#TYPEcharset_assoc">charset_assoc</a></code></pre>
<pre><span id="TYPEmime_type"><span class="keyword">type</span> <code class="type"></code>mime_type</span> = <code class="type">string</code> </pre>
<div class="info ">
MIME types; the default value is <code class="code">"application/octet-stream"</code><br>
</div>
<pre><span id="VALdefault_mime_type"><span class="keyword">val</span> default_mime_type</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEmime_type">mime_type</a></code></pre>
<pre><span id="TYPEmime_assoc"><span class="keyword">type</span> <code class="type"></code>mime_assoc</span> </pre>
<div class="info ">
association between extensions and mime types, with default value<br>
</div>
<pre><span id="VALdefault_mime_assoc"><span class="keyword">val</span> default_mime_assoc</span> : <code class="type">unit -> <a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a></code></pre><div class="info ">
Default values, obtained by reading the file specified by
<code class="code">Ocsigen_config.get_mimefile</code><br>
</div>
<pre><span id="VALparse_mime_types"><span class="keyword">val</span> parse_mime_types</span> : <code class="type">filename:string -> <a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a></code></pre><div class="info ">
Parsing of a file containing mime associations, such as /etc/mime-types<br>
</div>
<pre><span id="VALfind_mime"><span class="keyword">val</span> find_mime</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEfile">file</a> -> <a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a> -> string</code></pre>
<pre><span id="VALdefault_mime"><span class="keyword">val</span> default_mime</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a> -> <a href="Ocsigen_charset_mime.html#TYPEmime_type">mime_type</a></code></pre>
<pre><span id="VALset_default_mime"><span class="keyword">val</span> set_default_mime</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEmime_type">mime_type</a> -> <a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a></code></pre>
<pre><span id="VALupdate_mime_ext"><span class="keyword">val</span> update_mime_ext</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEextension">extension</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEmime_type">mime_type</a> -> <a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a></code></pre>
<pre><span id="VALupdate_mime_file"><span class="keyword">val</span> update_mime_file</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEfilename">filename</a> -><br> <a href="Ocsigen_charset_mime.html#TYPEmime_type">mime_type</a> -> <a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a></code></pre>
<pre><span id="VALupdate_mime_regexp"><span class="keyword">val</span> update_mime_regexp</span> : <code class="type"><a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a> -><br> Netstring_pcre.regexp -><br> <a href="Ocsigen_charset_mime.html#TYPEmime_type">mime_type</a> -> <a href="Ocsigen_charset_mime.html#TYPEmime_assoc">mime_assoc</a></code></pre></body></html>
