This commit is contained in:
c-cube 2025-05-05 14:16:16 +00:00
parent bfa9448665
commit d241ea0bd3
1371 changed files with 33566 additions and 2 deletions

0
.nojekyll Normal file
View file

View file

@ -1,2 +0,0 @@
theme: jekyll-theme-minimal
include: ["_odoc-theme", "_odoc_support"]

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View file

@ -0,0 +1,59 @@
@charset "UTF-8";
/* PT Sans */
@font-face
{ font-family: 'PT-Sans';
src: url('PTS55F.woff2') format('woff2');
font-weight: 400; font-style: normal; }
@font-face
{ font-family: 'PT-Sans';
src: url('PTS75F.woff2') format('woff2');
font-weight: 700; font-style: normal; }
@font-face
{ font-family: 'PT-Sans';
src: url('PTS56F.woff2') format('woff2');
font-weight: 400; font-style: italic; }
@font-face
{ font-family: 'PT-Sans';
src: url('PTS76F.woff2') format('woff2');
font-weight: 700; font-style: italic; }
/* PT Sans caption */
@font-face
{ font-family: 'PT-Sans-Caption';
src: url('PTC55F.woff2') format('woff2');
font-weight: 400; font-style: normal; }
@font-face
{ font-family: 'PT-Sans-Caption';
src: url('PTC75F.woff2') format('woff2');
font-weight: 700; font-style: normal; }
/* DejaVu 400 */
@font-face
{ font-family: 'DejaVu-SansMono';
src: url('DejaVuSansMono.woff2') format('woff2');
font-weight: 400; font-style: normal; }
@font-face
{ font-family: 'DejaVu-SansMono';
src: url('DejaVuSansMono-Oblique.woff2') format('woff2');
font-weight: 400; font-style: oblique; }
/* DejaVu 700 */
@font-face
{ font-family: 'DejaVu-SansMono';
src: url('DejaVuSansMono-Bold.woff2') format('woff2');
font-weight: 700; font-style: normal; }
@font-face
{ font-family: 'DejaVu-SansMono';
src: url('DejaVuSansMono-BoldOblique.woff2') format('woff2');
font-weight: 700; font-style: oblique; }

376
_odoc-theme/manual.css Normal file
View file

@ -0,0 +1,376 @@
@charset "UTF-8";
@import url("fonts/fonts.css");
@import url("theme.css");
/* Copyright (c) 2019 The odig programmers. All rights reserved.
Distributed under the ISC license, see terms at the end of the file.
odig v0.0.9 */
:root { --font-headings: "PT-Sans-Caption";
--font-body: "PT-Sans";
--font-mono: "DejaVu-SansMono";
--size-font: 0.96875rem;
--size-font-micro: calc(0.675 * var(--size-font));
--size-font-tiny-ratio: 0.75;
--size-font-tiny: calc(var(--size-font-tiny-ratio) * var(--size-font));
--size-font-small: calc(0.875 * var(--size-font));
--size-font-large: calc(1.25 * var(--size-font));
--size-font-big: calc(1.5 * var(--size-font));
--size-font-huge: calc(1.75 * var(--size-font));
--size-font-mono-ratio: 0.87097;
--size-line-ratio: 1.5;
--size-line: calc(var(--size-line-ratio) * var(--size-font));
--size-half-line: calc(0.5 * var(--size-line)); }
/* Reset a few things. */
html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,
a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp,select,
small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,
fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td,
article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup,
menu,nav,output,ruby,section,summary,time,mark,audio,video,button,input
{ margin: 0; padding: 0; border: 0; /* outline: 0; */
font-size: inherit; font: inherit; font-weight: inherit;
line-height: inherit; vertical-align: baseline;
text-align: inherit; color: inherit; background: transparent; }
table { border-collapse: collapse; border-spacing: 0; }
*, *:before, *:After { box-sizing: border-box; }
/* Note the stylesheet has quite hackish CSS selectors as the markup's
classification is sometimes a bit lacking. */
/* Geometry.
See also media adjustements at the end of the stylesheet. */
body { background-color: var(--color-bg);
color: var(--color-fg);
font-size: var(--size-font);
font-family: var(--font-body), sans-serif;
font-weight: 400;
line-height: var(--size-line);
text-align: left;
position: relative;
max-width: 120ch;
margin: 0 auto;
padding: calc(1.5 * var(--size-line));
padding-top: calc(0.5 * var(--size-line)); }
body > * { max-width: 80ch; width: 75% }
body > ul:first-of-type:not(.itemize):not(.ftoc2) /* toc */
{ position: absolute;
top: 0px; right: 0px;
width: 20%;
margin-left: var(--size-line);
margin-top: calc(2 * var(--size-line));
margin-right: var(--size-line);
border-top: solid thin var(--color-rule); }
/* Rules
We remove the top one, keep the last one and add one over h1 and h2 */
body > hr:last-of-type {
margin-top: var(--size-line);
border-style: none;
width: 100%;
max-width: 100%;
text-align: right;
border-top: solid thin var(--color-rule); }
body > hr:first-of-type { display: none } /* order with last-of-type imporant */
h1, h2 { border-top: solid thin var(--color-rule) }
/* Hacks */
body > a > img /* Navigation arrows, a bit problematic for dark themes */
{ display: inline-block; margin:0;
background-color: var(--color-code-block-bg); /* bof */ }
body > p br, h1 br { display: none; } /* brs should die */
/* Basic markup */
h1, h2, h3, h4, h5, h6
{ font-family: var(--font-headings), sans-serif;
font-weight: 400;
text-transform: uppercase;
margin-top: var(--size-line); }
h1, h2 { line-height: calc(1.5 * var(--size-line));
padding-top: calc(0.75 * var(--size-line)); }
hr + h1, hr + h2 { margin-top: calc(0.25 * var(--size-line)) }
h1 { font-size: var(--size-font-huge); }
h2 { font-size: var(--size-font-big); }
h3 { font-size: var(--size-font-large); }
div, nav, p, ol, ul, dl, pre, table, blockquote
{ margin-top: var(--size-half-line); }
ul, ol { list-style-position: outside }
ul { list-style-type: square }
ul > li { margin-left: 2.25ch; }
ol > li { margin-left: 2ch; }
em { font-style: italic }
b, strong { font-weight: 700 }
small { font-size: var(--size-font-small); }
sup { vertical-align: super; }
sub { vertical-align: sub; }
sup, sub { font-size : calc(1em * var(--size-font-tiny-ratio));
line-height: 0; margin-left: 0.2ex; }
img { display: block;
margin-top: var(--size-half-line); margin-bottom: var(--size-half-line); }
blockquote { margin-left: var(--size-half-line); }
/* Links and anchors. Note anchors need to be refined a bit further down
in certain cases. */
a { text-decoration:none; color: var(--color-link); }
a:hover { box-shadow:0 1px 0 0 var(--color-link); }
a.anchor:before { content: "#" }
a.anchor:hover { box-shadow: none; text-decoration: underline; }
*:hover > a.anchor { visibility: visible }
a.anchor
{ visibility: hidden; position: absolute;
font-weight: normal;
font-style: normal;
margin-left: -2.5ch;
padding-right: 1ch; padding-left: 1ch; /* To remain selectable */
color: var(--color-link);
text-align: right;
}
*:target /* Linked highlight */
{ background-color: var(--color-bg-highlight);
box-shadow: 0 0 0 3px var(--color-bg-highlight) }
/* Code and code highlighting */
.c003, .c004, .c005, .c006, .c015,
code, pre
{ font-family: var(--font-mono), monospace;
font-weight: 400;
font-size: calc(1em * var(--size-font-mono-ratio));
color: var(--color-code-fg); }
.c004, .c002 { color: var(--color-code-type-id); }
.c005 { font-style: oblique }
.c006 { font-weight: 700 }
.c015 { text-align: left }
pre .c003, pre .c004, pre .c005, pre .c006,
pre code { font-size: inherit } /* don't apply transform twice... */
a code { color: inherit }
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { text-transform: none; }
pre { background: var(--color-code-block-bg);
padding-left: 0.8ch; padding-right: 0.8ch;
margin-left: -0.8ch; margin-right: -0.8ch;
padding-top: 1ch; padding-bottom: 1ch;
white-space: pre-wrap;
word-wrap: break-word; }
/* Table of contents, like in odoc.css except we don't have a class */
body > ul:first-of-type:not(.itemize):not(.ftoc2)
{ font-size: var(--size-font-small); }
body > ul:first-of-type:not(.itemize):not(.ftoc2) a
{ color : var(--color-fg); }
body > ul:first-of-type:not(.itemize):not(.ftoc2) a:hover
{ color : var(--color-link); }
body > ul:first-of-type:not(.itemize):not(.ftoc2)
{ font-family: var(--font-headings); text-transform: uppercase;
list-style-type: none; padding-top: var(--size-line) }
body > ul:first-of-type:not(.itemize):not(.ftoc2) li
{ margin-left: 0; padding-left: 3.25ch; text-indent: -3.25ch; }
body > ul:first-of-type:not(.itemize):not(.ftoc2) ul
{ font-family: var(--font-body);
text-transform: none;
margin-top:0; }
/* toplevel examples */
div.caml-example.toplevel div.caml-input::before { content: "#" }
div.caml-input, div.caml-output { margin-top: 0; }
.caml-input {}
.caml-output { color: var(--color-code-string) /* why not */ }
/* Other HeVeA classes */
.c000 { border-spacing: 2ch; border-collapse: separate; margin: 0 auto; }
.c001 { border-spacing: 1ch; border-collapse: separate }
.c008 { font-size: var(--size-font-small) }
.c009 { font-style:italic }
.c010 { font-style:italic; color:var(--color-link) }
.c011 { font-style:italic; font-weight:700 }
.c012 { font-style:italic }
.c013 { font-style:italic }
.c018 { text-align: right }
.c019 { text-align: left}
.dcenter { margin: 0 auto; }
.description { margin-left: var(--size-line) }
.dd-description br { display: none }
dd + dt { margin-top: var(--size-half-line) }
dt .c003 { font-style:normal; font-weight:700 } /* options */
.indexenv { list-style-type: none }
.indexenv li { margin-left: 0 }
/* Page specific */
/* Cover page */
div.maintitle > span > span
{ text-transform: uppercase;
font-family: var(--font-headings);
line-height: var(--size-line-ratio);
font-size: calc(2.25 * var(--size-font)) !important;
margin-left: -0.25ch; /* compensate nbsp */ }
div.maintitle > span > span > br { display: none }
div.maintitle > span > span > span
{ display: block;
text-transform: none;
font-style: italic;
font-family: var(--font-body);
font-size: var(--size-font-big) !important; }
div.maintitle > span > span > span > span /* ugh */
{ font-style: normal;
line-height: var(--size-line);
font-size: var(--size-font) !important; }
div.maintitle > span > span > span > span > span /* ugh bis */
{ font-size: var(--size-font-small) !important;
font-style: italic;
margin-left: -1.25ch; }
div.maintitle + blockquote hr { display : none }
div.maintitle + blockquote
{ margin: 0;
/* margin-top: calc(-1 * var(--size-line)); chrome but not FF, bah... */
font-size: var(--size-font-small);
border-bottom: solid thin var(--color-rule);
padding-bottom: var(--size-half-line); }
div.maintitle ~ blockquote:last-of-type { display: none } /* remove branding */
div.maintitle ~ ul:first-of-type:not(.itemize):not(.ftoc2) /* undo side toc */
{ position: static;
padding: 0;
margin: 0; margin-top: var(--size-line);
width: 100%; }
div.maintitle ~ br { display: none }
div.maintitle ~ ul:first-of-type:not(.itemize):not(.ftoc2) > li { margin: 0; }
div.maintitle ~ ul:first-of-type:not(.itemize):not(.ftoc2) a
{ color: var(--color-link) }
div.maintitle ~ table { margin-top: 0 }
div.maintitle ~ ul:first-of-type:not(.itemize):not(.ftoc2)
{ list-style-type: none;
font-family: inherit; text-transform: inherit;
font-size: inherit;
margin-top: var(--size-half-line);
border: none; }
div.maintitle ~ ul { list-style-type: none }
div.maintitle ~ ul li { margin-left: 0 }
/* Contents page */
h1#sec1 + ul:first-of-type /* undo side toc */
{ position: static;
list-style-type: none;
margin: 0; margin-top: var(--size-half-line);
width: 100%; border: none; padding: 0;
font-size: var(--size-font-big); }
h1#sec1 + ul:first-of-type li
{ margin-left: 0; padding-left: 0; text-indent: 0 }
h1#sec1 ~ ul ul
{ list-style-type: none; font-size: var(--size-font-large); font-style: italic;}
h1#sec1 ~ ul ul ul
{ font-size: var(--size-font); font-style: normal;
margin-top: var(--size-half-line); }
h1#sec1 ~ ul ul ul ul { margin-left: 2.5ch; margin-top: 0;}
h1#sec1 ~ ul > li { margin-top: var(--size-line); }
h1#sec1 ~ ul > li > ul > li { margin-top: var(--size-half-line); }
/* Media adjustments */
@media only screen and (min-width:160ch) /* and (min-height: 60rem) */
{
:root { --size-font: 1.125rem; } /* consider using vmin units */
}
@media only screen and (max-width:80ch)
{
body { padding: var(--size-line); }
body > * { width: 100%; }
body > ul:first-of-type:not(.itemize):not(.ftoc2)
{ position: static;
margin: 0; margin-top: var(--size-line);
width: 100%; }
pre { font-size: var(--size-font-tiny); }
}
@media print
{
* { -webkit-print-color-adjust: exact; }
.content nav:first-child { visibility: hidden }
body > * { width: 100%; }
body > ul:first-of-type:not(.itemize):not(.ftoc2)
{ position: static; width: 100%;
margin: 0; margin-top: var(--size-line); }
/* odig.light with slight adjustements */
:root
{ --color-bg: white;
--color-bg-highlight: #CAD7EF;
--color-fg: black;
--color-rule: #DADBDB;
--color-code-block-bg: #E8E8E8;
--color-code-fg: #16191D;
--color-code-comment: #747679;
--color-code-keyword: #874aa9;
--color-code-type-id: #a9874a;
--color-code-string: #4aa987;
--color-link: #557dcc;
--color-broken-link: #f71414; }
}
/*
Copyright (c) 2019 The odig programmers
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

334
_odoc-theme/odoc.css Normal file
View file

@ -0,0 +1,334 @@
@charset "UTF-8";
@import url("fonts/fonts.css");
@import url("theme.css");
/* Copyright (c) 2019 The odig programmers. All rights reserved.
Distributed under the ISC license, see terms at the end of the file. */
/* Reset a few things. */
html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,
a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp,select,
small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,
fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td,
article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup,
menu,nav,output,ruby,section,summary,time,mark,audio,video,button,input
{ margin: 0; padding: 0; border: 0; /* outline: 0; */
font-size: inherit; font: inherit; font-weight: inherit;
line-height: inherit; vertical-align: baseline;
text-align: inherit; color: inherit; background: transparent; }
table { border-collapse: collapse; border-spacing: 0; }
*, *:before, *:after { box-sizing: border-box; }
/* Basic geometry */
:root { --font-headings: "PT-Sans-Caption";
--font-body: "PT-Sans";
--font-mono: "DejaVu-SansMono";
--size-font: 0.96875rem;
--size-font-micro: calc(0.675 * var(--size-font));
--size-font-tiny-ratio: 0.75;
--size-font-tiny: calc(var(--size-font-tiny-ratio) * var(--size-font));
--size-font-small: calc(0.875 * var(--size-font));
--size-font-large: calc(1.25 * var(--size-font));
--size-font-big: calc(1.5 * var(--size-font));
--size-font-huge: calc(1.75 * var(--size-font));
--size-font-mono-ratio: 0.87097;
--size-font-mono-ratio: 0.865;
--size-line-ratio: 1.5;
--size-line: calc(var(--size-line-ratio) * var(--size-font));
--size-half-line: calc(0.5 * var(--size-line));
--size-fourth-line: calc(0.25 * var(--size-line)); }
.odoc { background-color: var(--color-bg);
color: var(--color-fg);
font-size: var(--size-font);
font-family: var(--font-body), sans-serif;
font-weight: 400;
line-height: var(--size-line);
text-align: left;
display: grid;
margin: 0 auto;
max-width: 130ch;
grid-template-columns: minmax(50ch,76ch) minmax(23ch,1fr);
grid-column-gap: calc(2 * var(--size-line));
grid-template-areas: "nav nav"
"header toc"
"content toc";
padding: calc(1.5 * var(--size-line));
padding-top: calc(0.5 * var(--size-line)); }
.odoc-nav { grid-area: nav; }
.odoc-preamble { grid-area: header; }
.odoc-content { grid-area: content; margin: 0 }
.odoc-toc
{ grid-area: toc;
margin-top: var(--size-line);
border-top: solid thin var(--color-rule); }
/* Media adjustments */
@media only screen and (min-width:160ch) /* and (min-height: 60rem) */
{
:root { --size-font: 1.125rem; } /* consider using vmin units */
}
@media only screen and (max-width:80ch) /* Basically mobile */
{
.odoc
{ padding: var(--size-line);
grid-template-columns: auto;
grid-template-rows: none;
grid-template-areas: "nav"
"header"
"toc"
"content"; }
.odoc-toc { margin: 0; margin-top: var(--size-line); }
pre { font-size: var(--size-font-tiny); }
}
@media print
{
* { -webkit-print-color-adjust: exact; }
.odoc-nav { visibility: hidden }
.odoc-toc { margin: 0; margin-top: var(--size-line); }
/* odig.light with slight adjustements */
:root
{ --color-bg: white;
--color-bg-highlight: #CAD7EF;
--color-fg: black;
--color-rule: #DADBDB;
--color-code-block-bg: #E8E8E8;
--color-code-fg: #16191D;
--color-code-comment: #747679;
--color-code-keyword: #874aa9;
--color-code-type-id: #a9874a;
--color-code-string: #4aa987;
--color-link: #557dcc;
--color-broken-link: #f71414; }
}
/* Block level markup */
header > * + *, div > * + *, details > * + *
{ margin-top: var(--size-half-line); }
ul + * , ol + * { margin-top: 0; }
ul, ol { margin-top: var(--size-fourth-line);
margin-bottom: var(--size-fourth-line);
list-style-position: outside; }
li *:first-child, li ol, li ul { margin-top: 0; }
ul { list-style-type: square; }
ul > li { margin-left: 2.25ch; }
ol > li { margin-left: 2ch; }
ol li::marker
{ font-family: var(--font-headings), sans-serif;
font-size: var(--size-font-small); }
img
{ display: block;
margin-top: var(--size-half-line);
margin-bottom: var(--size-half-line); }
/* Headings and horizontal rulers */
h1, h2, .odoc-content > *:first-child
{ border-top: solid thin var(--color-rule);
padding-top: calc(0.75 * var(--size-line));
margin-top: var(--size-line); }
h1, h2, h3, h4, h5, h6
{ font-family: var(--font-headings), sans-serif;
font-weight: 400;
text-transform: uppercase;
margin-top: var(--size-line); }
h1, h2 { line-height: calc(1.5 * var(--size-line)); }
h1 { font-size: var(--size-font-huge); }
h2 { font-size: var(--size-font-big); }
h3 { font-size: var(--size-font-large); }
/* Phrasing content */
em { font-style: italic }
b, strong { font-weight: 700 }
small { font-size: var(--size-font-small); }
sup { vertical-align: super; }
sub { vertical-align: sub; }
sup, sub
{ font-size : calc(1em * var(--size-font-tiny-ratio));
line-height: 0; margin-left: 0.2ex; }
/* Code and code highlighting */
code, pre
{ font-family: var(--font-mono), monospace;
font-weight: 400;
font-size: calc(1em * var(--size-font-mono-ratio));
color: var(--color-code-fg);
overflow-wrap: anywhere; }
code span span { white-space: nowrap } /* Do not break these units */
pre code { font-size: inherit } /* don't apply transform twice... */
a code { color: inherit }
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { text-transform: none; }
pre
{ background: var(--color-code-block-bg);
padding-left: 0.8ch; padding-right: 0.8ch;
margin-left: -0.8ch; margin-right: -0.8ch;
padding-top: 1ch; padding-bottom: 1ch;
white-space: pre-wrap;
overflow-wrap: break-word; }
.arrow { white-space: nowrap }
.keyword , .hljs-keyword { color : var(--color-code-keyword); }
.hljs-type { color : var(--color-code-type-id); }
.hljs-string { color : var(--color-code-string); }
.hljs-comment { color : var(--color-code-comment); font-style: italic; }
/* Links and anchors. Note anchors need to be refined a bit further down
in certain cases. */
a { text-decoration:none; color: var(--color-link); }
a:hover { box-shadow:0 1px 0 0 var(--color-link); }
a.anchor:before { content: "#" }
a.anchor:hover { box-shadow: none; text-decoration: underline; }
*:hover > a.anchor { visibility: visible }
a.anchor
{ visibility: hidden; position: absolute;
font-weight: normal;
font-style: normal;
margin-left: -2.5ch;
padding-right: 1ch; padding-left: 1ch; /* To remain selectable */
color: var(--color-link);
text-align: right; }
*:target /* Linked highlight */
{ background-color: var(--color-bg-highlight);
box-shadow: 0 0 0 3px var(--color-bg-highlight) }
.xref-unresolved { box-shadow:0 1px 0 0 var(--color-broken-link)}
/* Table of contents */
.odoc-toc { font-size: var(--size-font-small); }
.odoc-toc a { color : var(--color-fg); }
.odoc-toc a:hover { color : var(--color-link) }
.odoc-toc ul
{ font-family: var(--font-headings); text-transform: uppercase;
margin-top: var(--size-line);
list-style-type: none; }
.odoc-toc ul ul
{ font-family: var(--font-body); text-transform: none; margin-top:0; }
.odoc-toc ul ul ul { margin-left:1.5ch }
.odoc-toc li { margin-left: 0; padding-left: 1ch; text-indent: -1ch; }
.odoc-toc > ul > li { margin-top: calc(0.25 * var(--size-half-line)) }
.odoc-toc > ul > li > ul > li:last-child
{ margin-bottom: var(--size-half-line) }
.odoc-toc ul ul li { margin-left: 0; padding-left: 0; }
/* Module structure items */
.odoc-spec { padding-bottom: var(--size-fourth-line); }
.spec { margin-top: 0; }
.spec-doc { margin-top:0; padding-left: 1ch; }
.spec-doc > *:first-child { margin-top: 0 }
/* Indent on wrap */
.spec, .spec td:first-child { padding-left: 4ch; text-indent: -4ch }
.spec td.field { padding-left: 6ch }
.spec .def-doc .comment-delim + * { margin-top: 0 }
.spec .def-doc .comment-delim /* make them invisible yet copy-pastable */
{ position: absolute; width: 1px; height: 1px; overflow: hidden; }
/* But we don't do it for types for now because of variants and
records. This makes :target highlight be off. And poses
other problems (e.g. need to indent back the last ] or }.
A better markup strategy should be found here. */
.spec.type { padding-left: 0; text-indent: 0 }
.spec.type > a.anchor
{ padding-left: 1ch; padding-right: 1ch; /* values from a.anchor */ }
.spec li > a.anchor, .spec > a.anchor
{ padding-right: 0.5ch; padding-left: 2ch; }
.spec ol { margin:0; list-style-type: none; }
.spec li { margin-left: 0; padding-left: 4ch; text-indent: -4ch }
.spec li.record.field { margin-left: 2ch }
.spec .def-doc { display: inline-block }
.spec .def-doc { padding-left: /* 4 + 3 */ 7ch; }
.spec .def-doc p { margin-left: -4ch; text-indent: 0 }
.odoc-include summary { cursor: pointer }
/* Package, module and @tag lists
Allowing indent on wrap with the anchor makes all this quite convoluted.
Is there a better way ? */
.packages, .modules, .at-tags { list-style-type: none; margin-left: -2ch; }
.packages li, .modules li, .at-tags li { padding-left: 2ch; text-indent: -2ch; }
.modules li a.anchor, .packages li a.anchor
{ padding-right: 0.5ch; padding-left: 2ch; }
.synopsis { padding-left: 1ch; }
.version { font-size: var(--size-font-micro); }
.at-tag { text-transform : capitalize }
/* Package page */
h1 .version, h1 nav { font-size: var(--size-font); line-height:0 }
h1 nav
{ display: inline-block;
font-family: var(--font-body);
text-transform: capitalize; }
.package.info td:first-child { padding-right: 2ch; min-width: 13ch}
.package.info ul { list-style-type: none; display: inline; margin:0; padding:0}
.package.info li { display: inline-block; margin:0; margin-right:1ex; }
#info-authors li, #info-maintainers li { display: block; }
/* Package index page */
.by-name nav a
{ font-family: var(--font-headings);
font-size: var(--size-font-large);
text-transform: uppercase;
margin-right: 1ch;
display: inline-block; }
.by-tag ol { list-style-type: none; }
.by-tag ol.tags li { margin-left: 1ch; display: inline-block }
.by-tag td:first-child
{ font-family: var(--font-headings);
font-size: var(--size-font-large);
text-transform: uppercase; }
/*
Copyright (c) 2019 The odig programmers
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

34
_odoc-theme/theme.css Normal file
View file

@ -0,0 +1,34 @@
:root
{ --color-bg: #F6F6F6;
--color-bg-highlight: #CAD7EF;
--color-fg: #1F2227;
--color-rule: #DADBDB;
--color-code-block-bg: #E8E8E8;
--color-code-fg: #16191D;
--color-code-comment: #747679;
--color-code-keyword: #874aa9;
--color-code-type-id: #a9874a;
--color-code-string: #4aa987;
--color-link: #557dcc;
--color-broken-link: #f71414; }
@media (prefers-color-scheme: dark)
{
:root
{ --color-bg: #181B20;
--color-bg-highlight: #303644;
--color-fg: #8C8D90;
--color-rule: #2F3236;
--color-code-block-bg: #24272A;
--color-code-fg: #A3A4A6;
--color-code-comment: #747679;
--color-code-keyword: #7F668D;
--color-code-type-id: #8D7F66;
--color-code-string: #668d7f;
--color-link: #7788AA;
--color-broken-link: #900505; }
}

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
fonts/KaTeX_Main-Bold.woff2 Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

634
highlight.pack.js Normal file

File diff suppressed because one or more lines are too long

2
hmap/Hmap/Key/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Key (hmap.Hmap.Key)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">hmap</a> &#x00BB; <a href="../index.html">Hmap</a> &#x00BB; Key</nav><header class="odoc-preamble"><h1>Module <code><span>Hmap.Key</span></code></h1><p>Keys.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#keys">Keys</a></li><li><a href="#exists">Existential keys</a></li></ul></nav></div><div class="odoc-content"><h2 id="keys"><a href="#keys" class="anchor"></a>Keys</h2><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span></span></code></div><div class="spec-doc"><p><code>create ()</code> is a new key.</p></div></div><h2 id="exists"><a href="#exists" class="anchor"></a>Existential keys</h2><p>Exisential keys allows to compare keys. This can be useful for functions like <a href="../index.html#val-filter"><code>filter</code></a>.</p><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>The type for existential keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hide_type"><a href="#val-hide_type" class="anchor"></a><code><span><span class="keyword">val</span> hide_type : <span><span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>hide_type k</code> is an existential key for <code>k</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>equal k k'</code> is <code>true</code> iff <code>k</code> and <code>k'</code> are the same key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>compare k k'</code> is a total order on keys compatible with <a href="#val-equal"><code>equal</code></a>.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Key (hmap.Hmap.Make.Key)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">hmap</a> &#x00BB; <a href="../../index.html">Hmap</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Key</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Key</span></code></h1><p>Keys.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#keys">Keys</a></li><li><a href="#exists">Existential keys</a></li></ul></nav></div><div class="odoc-content"><h2 id="keys"><a href="#keys" class="anchor"></a>Keys</h2><div class="odoc-spec"><div class="spec type anchored" id="type-info"><a href="#type-info" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a info</span></span><span> = <span><span class="type-var">'a</span> <a href="../argument-1-Key_info/index.html#type-t">Key_info.t</a></span></span></code></div><div class="spec-doc"><p>The type for key information.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span><span class="type-var">'a</span> <a href="#type-info">info</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span></span></code></div><div class="spec-doc"><p><code>create i</code> is a new key with information <code>i</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span><span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-info">info</a></span></span></code></div><div class="spec-doc"><p><code>info k</code> is <code>k</code>'s information.</p></div></div><h2 id="exists"><a href="#exists" class="anchor"></a>Existential keys</h2><p>Exisential keys allow to compare keys. This can be useful for functions like <a href="../index.html#val-filter"><code>filter</code></a>.</p><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>The type for existential keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hide_type"><a href="#val-hide_type" class="anchor"></a><code><span><span class="keyword">val</span> hide_type : <span><span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>hide_type k</code> is an existential key for <code>k</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>equal k k'</code> is <code>true</code> iff <code>k</code> and <code>k'</code> are the same key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>compare k k'</code> is a total order on keys compatible with <a href="#val-equal"><code>equal</code></a>.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Key_info (hmap.Hmap.Make.Key_info)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">hmap</a> &#x00BB; <a href="../../index.html">Hmap</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Key_info</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.Key_info</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div><div class="spec-doc"><p>The type for key information.</p></div></div></div></body></html>

File diff suppressed because one or more lines are too long

2
hmap/Hmap/index.html Normal file

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>KEY_INFO (hmap.Hmap.KEY_INFO)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">hmap</a> &#x00BB; <a href="../index.html">Hmap</a> &#x00BB; KEY_INFO</nav><header class="odoc-preamble"><h1>Module type <code><span>Hmap.KEY_INFO</span></code></h1><p>The type for key information.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div><div class="spec-doc"><p>The type for key information.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Key (hmap.Hmap.S.Key)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">hmap</a> &#x00BB; <a href="../../index.html">Hmap</a> &#x00BB; <a href="../index.html">S</a> &#x00BB; Key</nav><header class="odoc-preamble"><h1>Module <code><span>S.Key</span></code></h1><p>Keys.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#keys">Keys</a></li><li><a href="#exists">Existential keys</a></li></ul></nav></div><div class="odoc-content"><h2 id="keys"><a href="#keys" class="anchor"></a>Keys</h2><div class="odoc-spec"><div class="spec type anchored" id="type-info"><a href="#type-info" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a info</span></span></code></div><div class="spec-doc"><p>The type for key information.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span><span class="type-var">'a</span> <a href="#type-info">info</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span></span></code></div><div class="spec-doc"><p><code>create i</code> is a new key with information <code>i</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span><span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-info">info</a></span></span></code></div><div class="spec-doc"><p><code>info k</code> is <code>k</code>'s information.</p></div></div><h2 id="exists"><a href="#exists" class="anchor"></a>Existential keys</h2><p>Exisential keys allow to compare keys. This can be useful for functions like <a href="../index.html#val-filter"><code>filter</code></a>.</p><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>The type for existential keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hide_type"><a href="#val-hide_type" class="anchor"></a><code><span><span class="keyword">val</span> hide_type : <span><span><span class="type-var">'a</span> <a href="../index.html#type-key">key</a></span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>hide_type k</code> is an existential key for <code>k</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>equal k k'</code> is <code>true</code> iff <code>k</code> and <code>k'</code> are the same key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>compare k k'</code> is a total order on keys compatible with <a href="#val-equal"><code>equal</code></a>.</p></div></div></div></body></html>

File diff suppressed because one or more lines are too long

9
hmap/_doc-dir/CHANGES.md Normal file
View file

@ -0,0 +1,9 @@
v0.8.1 2017-10-03 Zagreb
------------------------
* Build depend on topkg.
v0.8.0 2016-03-08 La Forclaz (VS)
---------------------------------
First release.

13
hmap/_doc-dir/LICENSE.md Normal file
View file

@ -0,0 +1,13 @@
Copyright (c) 2016 Daniel C. Bünzli
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

43
hmap/_doc-dir/README.md Normal file
View file

@ -0,0 +1,43 @@
Hmap — Heterogeneous value maps for OCaml
-------------------------------------------------------------------------------
v0.8.1
Hmap provides heterogeneous value maps for OCaml. These maps bind keys
to values with arbitrary types. Keys witness the type of the value
they are bound to which allows to add and lookup bindings in a type
safe manner.
Hmap has no dependency and is distributed under the ISC license.
Home page: http://erratique.ch/software/hmap
Contact: Daniel Bünzli `<daniel.buenzl i@erratique.ch>`
## Installation
Hmap can be installed with `opam`:
opam install hmap
If you don't use `opam` consult the [`opam`](opam) file for build
instructions.
## Documentation
The documentation and API reference is automatically generated by
`ocamldoc` from the interfaces. It can be consulted [online][doc]
and there is a generated version in the `doc` directory of the
distribution.
[doc]: http://erratique.ch/software/hmap/doc
## Sample programs
If you installed Hmap with `opam` sample programs are located in
the directory `opam config var hmap:doc`.
In the distribution sample programs and tests are located in the
[`test`](test) directory of the distribution. They can be built an run
with
topkg build --tests true
topkg test

2
hmap/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (hmap.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../index.html">Index</a> &#x00BB; hmap</nav><header class="odoc-preamble"><h1 id="package-hmap"><a href="#package-hmap" class="anchor"></a>Package hmap <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Hmap/index.html"><code>Hmap</code></a> <span class="synopsis">Heterogeneous value maps.</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>

2
index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html><head><meta charset="utf-8"><meta name="generator" content="odig v0.0.9"><meta name="viewport" content="width=device-width, initial-scale=1.0"><link rel="stylesheet" type="text/css" media="screen, print" href="_odoc-theme/odoc.css"><title>_opam</title></head><body class="odoc"><nav class="odoc-nav">🐫</nav><header class="odoc-preamble"><h1>OCaml package documentation</h1><p>Browse <a href="#by-name">by name</a>, <a href="#by-tag">by tag</a>, the <a href="ocaml/Stdlib/index.html#modules">standard library</a> and the <a href="https://ocaml.org/manual/">OCaml manual</a> (online, latest version).</p><p><small>Generated for <code>/home/runner/work/nanoev/nanoev/_opam/lib</code></small></p></header><nav class="odoc-toc"><ul><li><a href="ocaml/Stdlib/index.html#modules">OCaml standard library</a></li><li><a href="https://ocaml.org/manual/">OCaml manual</a></li><li><a href="#by-name">Packages by name</a></li><li><a href="#by-tag">Packages by tag</a></li></ul></nav><div class="odoc-content"><h2 id="by-name"><a href="#by-name" aria-hidden="true" class="anchor"></a>Packages by name</h2><div class="by-name"><nav><a href="#name-h">h</a><a href="#name-i">i</a><a href="#name-n">n</a><a href="#name-o">o</a><a href="#name-p">p</a><a href="#name-t">t</a></nav><h3 id="name-h"><a href="#name-h" aria-hidden="true" class="anchor"></a>h</h3><ol class="packages"><li id="package-hmap"><a href="#package-hmap" aria-hidden="true" class="anchor"></a><a href="hmap/index.html">hmap</a> <span class="version"></span> <span class="synopsis"></span></li></ol><h3 id="name-i"><a href="#name-i" aria-hidden="true" class="anchor"></a>i</h3><ol class="packages"><li id="package-iostream"><a href="#package-iostream" aria-hidden="true" class="anchor"></a><a href="iostream/index.html">iostream</a> <span class="version"></span> <span class="synopsis"></span></li></ol><h3 id="name-n"><a href="#name-n" aria-hidden="true" class="anchor"></a>n</h3><ol class="packages"><li id="package-nanoev"><a href="#package-nanoev" aria-hidden="true" class="anchor"></a><a href="nanoev/index.html">nanoev</a> <span class="version"></span> <span class="synopsis"></span></li><li id="package-nanoev-picos"><a href="#package-nanoev-picos" aria-hidden="true" class="anchor"></a><a href="nanoev-picos/index.html">nanoev-picos</a> <span class="version"></span> <span class="synopsis"></span></li><li id="package-nanoev-posix"><a href="#package-nanoev-posix" aria-hidden="true" class="anchor"></a><a href="nanoev-posix/index.html">nanoev-posix</a> <span class="version"></span> <span class="synopsis"></span></li><li id="package-nanoev_tiny_httpd"><a href="#package-nanoev_tiny_httpd" aria-hidden="true" class="anchor"></a><a href="nanoev_tiny_httpd/index.html">nanoev_tiny_httpd</a> <span class="version"></span> <span class="synopsis"></span></li></ol><h3 id="name-o"><a href="#name-o" aria-hidden="true" class="anchor"></a>o</h3><ol class="packages"><li id="package-ocaml"><a href="#package-ocaml" aria-hidden="true" class="anchor"></a><a href="ocaml/index.html">ocaml</a> <span class="version"></span> <span class="synopsis"></span></li></ol><h3 id="name-p"><a href="#name-p" aria-hidden="true" class="anchor"></a>p</h3><ol class="packages"><li id="package-picos"><a href="#package-picos" aria-hidden="true" class="anchor"></a><a href="picos/index.html">picos</a> <span class="version"></span> <span class="synopsis"></span></li></ol><h3 id="name-t"><a href="#name-t" aria-hidden="true" class="anchor"></a>t</h3><ol class="packages"><li id="package-tiny_httpd"><a href="#package-tiny_httpd" aria-hidden="true" class="anchor"></a><a href="tiny_httpd/index.html">tiny_httpd</a> <span class="version"></span> <span class="synopsis"></span></li><li id="package-trace"><a href="#package-trace" aria-hidden="true" class="anchor"></a><a href="trace/index.html">trace</a> <span class="version"></span> <span class="synopsis"></span></li></ol></div><h2 id="by-tag"><a href="#by-tag" aria-hidden="true" class="anchor"></a>Packages by tag</h2><div class="by-tag"><nav><table></table></nav></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>empty (iostream.Iostream.In.empty)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In</a> &#x00BB; empty</nav><header class="odoc-preamble"><h1>Class <code><span>In.empty</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-input"><a href="#method-input" class="anchor"></a><code><span><span class="keyword">method</span> input : <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Read into the slice. Returns <code>0</code> only if the stream is closed.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close the input. Must be idempotent.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_bytes (iostream.Iostream.In.of_bytes)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In</a> &#x00BB; of_bytes</nav><header class="odoc-preamble"><h1>Class <code><span>In.of_bytes</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_in_channel (iostream.Iostream.In.of_in_channel)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In</a> &#x00BB; of_in_channel</nav><header class="odoc-preamble"><h1>Class <code><span>In.of_in_channel</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_string (iostream.Iostream.In.of_string)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In</a> &#x00BB; of_string</nav><header class="odoc-preamble"><h1>Class <code><span>In.of_string</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>open_file (iostream.Iostream.In.open_file)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In</a> &#x00BB; open_file</nav><header class="odoc-preamble"><h1>Class <code><span>In.open_file</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (iostream.Iostream.In.t)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In</a> &#x00BB; t</nav><header class="odoc-preamble"><h1>Class type <code><span>In.t</span></code></h1><p>An input stream, i.e an incoming stream of bytes.</p><p>This can be a <code>string</code>, an <code>int_channel</code>, an <code>Unix.file_descr</code>, a decompression wrapper around another input stream, etc.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-input"><a href="#method-input" class="anchor"></a><code><span><span class="keyword">method</span> input : <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Read into the slice. Returns <code>0</code> only if the stream is closed.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close the input. Must be idempotent.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t_seekable (iostream.Iostream.In.t_seekable)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In</a> &#x00BB; t_seekable</nav><header class="odoc-preamble"><h1>Class type <code><span>In.t_seekable</span></code></h1><p>An input stream that is also seekable.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>bufferized (iostream.Iostream.In_buf.bufferized)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In_buf</a> &#x00BB; bufferized</nav><header class="odoc-preamble"><h1>Class <code><span>In_buf.bufferized</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.In.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-fill_buf"><a href="#method-fill_buf" class="anchor"></a><code><span><span class="keyword">method</span> fill_buf : <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Iostream__.Slice.t</span></span></code></div><div class="spec-doc"><p><code>ic#fill_buf()</code> returns a slice into the <code>ic</code>'s internal buffer, and ensures it's empty only if <code>ic.ic</code> is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-consume"><a href="#method-consume" class="anchor"></a><code><span><span class="keyword">method</span> consume : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Consume <code>n</code> bytes from the inner buffer. This is only valid if the last call to <code>fill_buf</code> returned a slice with at least <code>n</code> bytes.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_bytes (iostream.Iostream.In_buf.of_bytes)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In_buf</a> &#x00BB; of_bytes</nav><header class="odoc-preamble"><h1>Class <code><span>In_buf.of_bytes</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.In.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-fill_buf"><a href="#method-fill_buf" class="anchor"></a><code><span><span class="keyword">method</span> fill_buf : <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Iostream__.Slice.t</span></span></code></div><div class="spec-doc"><p><code>ic#fill_buf()</code> returns a slice into the <code>ic</code>'s internal buffer, and ensures it's empty only if <code>ic.ic</code> is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-consume"><a href="#method-consume" class="anchor"></a><code><span><span class="keyword">method</span> consume : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Consume <code>n</code> bytes from the inner buffer. This is only valid if the last call to <code>fill_buf</code> returned a slice with at least <code>n</code> bytes.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_in_channel (iostream.Iostream.In_buf.of_in_channel)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In_buf</a> &#x00BB; of_in_channel</nav><header class="odoc-preamble"><h1>Class <code><span>In_buf.of_in_channel</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.In.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-fill_buf"><a href="#method-fill_buf" class="anchor"></a><code><span><span class="keyword">method</span> fill_buf : <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Iostream__.Slice.t</span></span></code></div><div class="spec-doc"><p><code>ic#fill_buf()</code> returns a slice into the <code>ic</code>'s internal buffer, and ensures it's empty only if <code>ic.ic</code> is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-consume"><a href="#method-consume" class="anchor"></a><code><span><span class="keyword">method</span> consume : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Consume <code>n</code> bytes from the inner buffer. This is only valid if the last call to <code>fill_buf</code> returned a slice with at least <code>n</code> bytes.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_string (iostream.Iostream.In_buf.of_string)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In_buf</a> &#x00BB; of_string</nav><header class="odoc-preamble"><h1>Class <code><span>In_buf.of_string</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.In.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-fill_buf"><a href="#method-fill_buf" class="anchor"></a><code><span><span class="keyword">method</span> fill_buf : <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Iostream__.Slice.t</span></span></code></div><div class="spec-doc"><p><code>ic#fill_buf()</code> returns a slice into the <code>ic</code>'s internal buffer, and ensures it's empty only if <code>ic.ic</code> is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-consume"><a href="#method-consume" class="anchor"></a><code><span><span class="keyword">method</span> consume : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Consume <code>n</code> bytes from the inner buffer. This is only valid if the last call to <code>fill_buf</code> returned a slice with at least <code>n</code> bytes.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>open_file (iostream.Iostream.In_buf.open_file)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In_buf</a> &#x00BB; open_file</nav><header class="odoc-preamble"><h1>Class <code><span>In_buf.open_file</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.In.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-fill_buf"><a href="#method-fill_buf" class="anchor"></a><code><span><span class="keyword">method</span> fill_buf : <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Iostream__.Slice.t</span></span></code></div><div class="spec-doc"><p><code>ic#fill_buf()</code> returns a slice into the <code>ic</code>'s internal buffer, and ensures it's empty only if <code>ic.ic</code> is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-consume"><a href="#method-consume" class="anchor"></a><code><span><span class="keyword">method</span> consume : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Consume <code>n</code> bytes from the inner buffer. This is only valid if the last call to <code>fill_buf</code> returned a slice with at least <code>n</code> bytes.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t_from_refill (iostream.Iostream.In_buf.t_from_refill)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In_buf</a> &#x00BB; t_from_refill</nav><header class="odoc-preamble"><h1>Class <code><span>In_buf.t_from_refill</span></code></h1><p>A mixin to implement a buffered input by only providing a <code>refill</code> method. Add a <code>close</code> method and it's good to go.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-refill"><a href="#method-refill" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> <span class="keyword">virtual</span> refill : <span><span class="xref-unresolved">Iostream__.Slice.t</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Implementation of the stream: this takes a slice, resets its offset, and fills it with bytes. It must write at least one byte in the slice, unless the underlying input has reached its end.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-input"><a href="#method-input" class="anchor"></a><code><span><span class="keyword">method</span> input : <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-fill_buf"><a href="#method-fill_buf" class="anchor"></a><code><span><span class="keyword">method</span> fill_buf : <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Iostream__.Slice.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-consume"><a href="#method-consume" class="anchor"></a><code><span><span class="keyword">method</span> consume : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (iostream.Iostream.In_buf.t)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In_buf</a> &#x00BB; t</nav><header class="odoc-preamble"><h1>Class type <code><span>In_buf.t</span></code></h1><p>The implementation of buffered input streams.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.In.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-fill_buf"><a href="#method-fill_buf" class="anchor"></a><code><span><span class="keyword">method</span> fill_buf : <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Iostream__.Slice.t</span></span></code></div><div class="spec-doc"><p><code>ic#fill_buf()</code> returns a slice into the <code>ic</code>'s internal buffer, and ensures it's empty only if <code>ic.ic</code> is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-consume"><a href="#method-consume" class="anchor"></a><code><span><span class="keyword">method</span> consume : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Consume <code>n</code> bytes from the inner buffer. This is only valid if the last call to <code>fill_buf</code> returned a slice with at least <code>n</code> bytes.</p></div></div></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>dummy (iostream.Iostream.Out.dummy)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out</a> &#x00BB; dummy</nav><header class="odoc-preamble"><h1>Class <code><span>Out.dummy</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-output"><a href="#method-output" class="anchor"></a><code><span><span class="keyword">method</span> output : <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output slice</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close the output. Must be idempotent.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>map_char (iostream.Iostream.Out.map_char)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out</a> &#x00BB; map_char</nav><header class="odoc-preamble"><h1>Class <code><span>Out.map_char</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-output"><a href="#method-output" class="anchor"></a><code><span><span class="keyword">method</span> output : <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output slice</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close the output. Must be idempotent.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_buffer (iostream.Iostream.Out.of_buffer)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out</a> &#x00BB; of_buffer</nav><header class="odoc-preamble"><h1>Class <code><span>Out.of_buffer</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-output"><a href="#method-output" class="anchor"></a><code><span><span class="keyword">method</span> output : <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output slice</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close the output. Must be idempotent.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_out_channel (iostream.Iostream.Out.of_out_channel)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out</a> &#x00BB; of_out_channel</nav><header class="odoc-preamble"><h1>Class <code><span>Out.of_out_channel</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (iostream.Iostream.Out.t)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out</a> &#x00BB; t</nav><header class="odoc-preamble"><h1>Class type <code><span>Out.t</span></code></h1><p>An output stream, ie. a place into which we can write bytes. This can be a <code>Buffer.t</code>, an <code>out_channel</code>, a <code>Unix.file_descr</code>, etc.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-output"><a href="#method-output" class="anchor"></a><code><span><span class="keyword">method</span> output : <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output slice</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close the output. Must be idempotent.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t_seekable (iostream.Iostream.Out.t_seekable)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out</a> &#x00BB; t_seekable</nav><header class="odoc-preamble"><h1>Class type <code><span>Out.t_seekable</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,13 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Out (iostream.Iostream.Out)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">iostream</a> &#x00BB; <a href="../index.html">Iostream</a> &#x00BB; Out</nav><header class="odoc-preamble"><h1>Module <code><span>Iostream.Out</span></code></h1><p>Output stream.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec class-type anchored" id="class-type-t"><a href="#class-type-t" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">type</span> </span><span><a href="class-type-t/index.html">t</a></span><span> = <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>An output stream, ie. a place into which we can write bytes. This can be a <code>Buffer.t</code>, an <code>out_channel</code>, a <code>Unix.file_descr</code>, etc.</p></div></div><div class="odoc-spec"><div class="spec class-type anchored" id="class-type-t_seekable"><a href="#class-type-t_seekable" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">type</span> </span><span><a href="class-type-t_seekable/index.html">t_seekable</a></span><span> = <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-dummy"><a href="#class-dummy" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-dummy/index.html">dummy</a></span><span> : <a href="class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy"><a href="#val-dummy" class="anchor"></a><code><span><span class="keyword">val</span> dummy : <a href="class-type-t/index.html">t</a></span></code></div><div class="spec-doc"><p>Dummy output, drops everything written to it.</p></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-of_out_channel"><a href="#class-of_out_channel" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-of_out_channel/index.html">of_out_channel</a></span><span> : <span><span class="optlabel">?close_noerr</span>:bool <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../ocaml/Stdlib/index.html#type-out_channel">out_channel</a> <span class="arrow">&#45;&gt;</span></span> <a href="class-type-t_seekable/index.html">t_seekable</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_out_channel"><a href="#val-of_out_channel" class="anchor"></a><code><span><span class="keyword">val</span> of_out_channel : <span><span class="optlabel">?close_noerr</span>:bool <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../ocaml/Stdlib/index.html#type-out_channel">out_channel</a> <span class="arrow">&#45;&gt;</span></span> <a href="class-type-t_seekable/index.html">t_seekable</a></span></code></div><div class="spec-doc"><p>Wrap an out channel.</p></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-of_buffer"><a href="#class-of_buffer" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-of_buffer/index.html">of_buffer</a></span><span> : <span><a href="../../../ocaml/Stdlib/Buffer/index.html#type-t">Stdlib.Buffer.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_buffer"><a href="#val-of_buffer" class="anchor"></a><code><span><span class="keyword">val</span> of_buffer : <span><a href="../../../ocaml/Stdlib/Buffer/index.html#type-t">Stdlib.Buffer.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="class-type-t/index.html">t</a></span></code></div><div class="spec-doc"><p><code>of_buffer buf</code> is an output channel that writes directly into <code>buf</code>. <code>flush</code> and <code>close</code> have no effect.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-open_file"><a href="#val-open_file" class="anchor"></a><code><span><span class="keyword">val</span> open_file :
<span><span class="optlabel">?close_noerr</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?flags</span>:<span><a href="../../../ocaml/Stdlib/index.html#type-open_flag">open_flag</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<a href="class-type-t_seekable/index.html">t_seekable</a></span></code></div><div class="spec-doc"><p><code>open_file file</code> creates an out stream writing into the given file.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">mode</span> <p>permissions for the file creation</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">flags</span> <p>set of unix flags to use. It must contain write permissions.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_open_file"><a href="#val-with_open_file" class="anchor"></a><code><span><span class="keyword">val</span> with_open_file :
<span><span class="optlabel">?close_noerr</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?flags</span>:<span><a href="../../../ocaml/Stdlib/index.html#type-open_flag">open_flag</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><a href="class-type-t_seekable/index.html">t_seekable</a> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-output"><a href="#val-output" class="anchor"></a><code><span><span class="keyword">val</span> output : <span><a href="class-type-t/index.html">t</a> <span class="arrow">&#45;&gt;</span></span> <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Write the slice of bytes.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><a href="class-type-t/index.html">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close the stream. Idempotent.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-output_string"><a href="#val-output_string" class="anchor"></a><code><span><span class="keyword">val</span> output_string : <span><a href="class-type-t/index.html">t</a> <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output the whole string.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-output_int"><a href="#val-output_int" class="anchor"></a><code><span><span class="keyword">val</span> output_int : <span><a href="class-type-t/index.html">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output an integer in decimal notation.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tee"><a href="#val-tee" class="anchor"></a><code><span><span class="keyword">val</span> tee : <span><span><a href="class-type-t/index.html">t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <a href="class-type-t/index.html">t</a></span></code></div><div class="spec-doc"><p><code>tee ocs</code> is an output that accepts bytes and writes them to every output in <code>ocs</code>. When closed, it closes all elements of <code>oc</code>.</p></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-map_char"><a href="#class-map_char" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-map_char/index.html">map_char</a></span><span> : <span><span>(<span>char <span class="arrow">&#45;&gt;</span></span> char)</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="class-type-t/index.html">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map_char"><a href="#val-map_char" class="anchor"></a><code><span><span class="keyword">val</span> map_char : <span><span>(<span>char <span class="arrow">&#45;&gt;</span></span> char)</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="class-type-t/index.html">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="class-type-t/index.html">t</a></span></code></div><div class="spec-doc"><p>Transform the stream byte by byte</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>bufferized (iostream.Iostream.Out_buf.bufferized)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out_buf</a> &#x00BB; bufferized</nav><header class="odoc-preamble"><h1>Class <code><span>Out_buf.bufferized</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Out.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-output_char"><a href="#method-output_char" class="anchor"></a><code><span><span class="keyword">method</span> output_char : <span>char <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output a single char</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-flush"><a href="#method-flush" class="anchor"></a><code><span><span class="keyword">method</span> flush : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Flush underlying buffer</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>dummy (iostream.Iostream.Out_buf.dummy)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out_buf</a> &#x00BB; dummy</nav><header class="odoc-preamble"><h1>Class <code><span>Out_buf.dummy</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Out.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-output_char"><a href="#method-output_char" class="anchor"></a><code><span><span class="keyword">method</span> output_char : <span>char <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output a single char</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-flush"><a href="#method-flush" class="anchor"></a><code><span><span class="keyword">method</span> flush : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Flush underlying buffer</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_buffer (iostream.Iostream.Out_buf.of_buffer)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out_buf</a> &#x00BB; of_buffer</nav><header class="odoc-preamble"><h1>Class <code><span>Out_buf.of_buffer</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Out.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-output_char"><a href="#method-output_char" class="anchor"></a><code><span><span class="keyword">method</span> output_char : <span>char <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output a single char</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-flush"><a href="#method-flush" class="anchor"></a><code><span><span class="keyword">method</span> flush : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Flush underlying buffer</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>of_out_channel (iostream.Iostream.Out_buf.of_out_channel)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out_buf</a> &#x00BB; of_out_channel</nav><header class="odoc-preamble"><h1>Class <code><span>Out_buf.of_out_channel</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>open_file (iostream.Iostream.Out_buf.open_file)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out_buf</a> &#x00BB; open_file</nav><header class="odoc-preamble"><h1>Class <code><span>Out_buf.open_file</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t_from_output (iostream.Iostream.Out_buf.t_from_output)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out_buf</a> &#x00BB; t_from_output</nav><header class="odoc-preamble"><h1>Class <code><span>Out_buf.t_from_output</span></code></h1><p>Make a bufferized output from a non bufferized output+close.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">bytes</span> <p>the buffer to use. It's owned by this channel as long as the channel exists.</p></li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-output_underlying"><a href="#method-output_underlying" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> <span class="keyword">virtual</span> output_underlying : <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Emit these private bytes, unbufferized</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close_underlying"><a href="#method-close_underlying" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> <span class="keyword">virtual</span> close_underlying : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close the underlying output. The bufferized output will flush and then call this.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (iostream.Iostream.Out_buf.t)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out_buf</a> &#x00BB; t</nav><header class="odoc-preamble"><h1>Class type <code><span>Out_buf.t</span></code></h1><p>An output stream, ie. a place into which we can write bytes, with a buffer to amortize the cost of operations.</p><p>This can be a <code>Buffer.t</code>, an <code>out_channel</code>, a <code>Unix.file_descr</code>, etc.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Out.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-output_char"><a href="#method-output_char" class="anchor"></a><code><span><span class="keyword">method</span> output_char : <span>char <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Output a single char</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-flush"><a href="#method-flush" class="anchor"></a><code><span><span class="keyword">method</span> flush : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Flush underlying buffer</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t_seekable (iostream.Iostream.Out_buf.t_seekable)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Out_buf</a> &#x00BB; t_seekable</nav><header class="odoc-preamble"><h1>Class type <code><span>Out_buf.t_seekable</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.Seekable.t</span></span></code></div></div></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (iostream.Iostream.Seekable.t)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">Seekable</a> &#x00BB; t</nav><header class="odoc-preamble"><h1>Class type <code><span>Seekable.t</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-seek"><a href="#method-seek" class="anchor"></a><code><span><span class="keyword">method</span> seek : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Seek in the underlying stream.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Sys_error</code> <p>in case of failure</p></li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-pos"><a href="#method-pos" class="anchor"></a><code><span><span class="keyword">method</span> pos : <span>unit <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Return current offset in underlying stream.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Sys_error</code> <p>in case of failure</p></li></ul></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Seekable (iostream.Iostream.Seekable)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">iostream</a> &#x00BB; <a href="../index.html">Iostream</a> &#x00BB; Seekable</nav><header class="odoc-preamble"><h1>Module <code><span>Iostream.Seekable</span></code></h1><p>An object we can seek in.</p><p>Files can be seeked in, i.e the read/write head can move around.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec class-type anchored" id="class-type-t"><a href="#class-type-t" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">type</span> </span><span><a href="class-type-t/index.html">t</a></span><span> = <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-seek"><a href="#val-seek" class="anchor"></a><code><span><span class="keyword">val</span> seek : <span><a href="class-type-t/index.html">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pos"><a href="#val-pos" class="anchor"></a><code><span><span class="keyword">val</span> pos : <span><a href="class-type-t/index.html">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Slice (iostream.Iostream.Slice)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">iostream</a> &#x00BB; <a href="../index.html">Iostream</a> &#x00BB; Slice</nav><header class="odoc-preamble"><h1>Module <code><span>Iostream.Slice</span></code></h1><p>Byte slice or buffer.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <a href="../../Iostream_types/Slice/index.html#type-t">Iostream_types.Slice.t</a></span><span> = </span><span>{</span></code><ol><li id="type-t.bytes" class="def record field anchored"><a href="#type-t.bytes" class="anchor"></a><code><span>bytes : bytes;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Bytes</p><span class="comment-delim">*)</span></div></li><li id="type-t.off" class="def record field anchored"><a href="#type-t.off" class="anchor"></a><code><span><span class="keyword">mutable</span> off : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Offset in bytes</p><span class="comment-delim">*)</span></div></li><li id="type-t.len" class="def record field anchored"><a href="#type-t.len" class="anchor"></a><code><span><span class="keyword">mutable</span> len : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Length of the slice. Empty slice has <code>len=0</code></p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A slice of bytes. The valid bytes in the slice are <code>bytes[off], bytes[off+1], …, bytes[off+len-1]</code> (i.e <code>len</code> bytes starting at offset <code>off</code>).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span><span class="keyword">val</span> empty : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>int <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_bytes"><a href="#val-of_bytes" class="anchor"></a><code><span><span class="keyword">val</span> of_bytes : <span>bytes <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bytes"><a href="#val-bytes" class="anchor"></a><code><span><span class="keyword">val</span> bytes : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-off"><a href="#val-off" class="anchor"></a><code><span><span class="keyword">val</span> off : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-len"><a href="#val-len" class="anchor"></a><code><span><span class="keyword">val</span> len : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-consume"><a href="#val-consume" class="anchor"></a><code><span><span class="keyword">val</span> consume : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Consume the first <code>n</code> bytes from the slice, making it <code>n</code> bytes shorter. This modifies the slice in place.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_index_exn"><a href="#val-find_index_exn" class="anchor"></a><code><span><span class="keyword">val</span> find_index_exn : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>char <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>find index of <code>c</code> in slice, or raise <code>Not_found</code></p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Iostream (iostream.Iostream)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">iostream</a> &#x00BB; Iostream</nav><header class="odoc-preamble"><h1>Module <code><span>Iostream</span></code></h1><p>I/O streams.</p><p>This module defines generic I/O streams. They can be user-defined and can be composed from other streams.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-In"><a href="#module-In" class="anchor"></a><code><span><span class="keyword">module</span> <a href="In/index.html">In</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Input stream.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-In_buf"><a href="#module-In_buf" class="anchor"></a><code><span><span class="keyword">module</span> <a href="In_buf/index.html">In_buf</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Buffered input stream.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Out"><a href="#module-Out" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Out/index.html">Out</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Output stream.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Out_buf"><a href="#module-Out_buf" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Out_buf/index.html">Out_buf</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Buffered output stream.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Slice"><a href="#module-Slice" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Slice/index.html">Slice</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Byte slice or buffer.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Seekable"><a href="#module-Seekable" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Seekable/index.html">Seekable</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>An object we can seek in.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Iostream__ (iostream.Iostream__)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">iostream</a> &#x00BB; Iostream__</nav><header class="odoc-preamble"><h1>Module <code><span>Iostream__</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Iostream__In (iostream.Iostream__In)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">iostream</a> &#x00BB; Iostream__In</nav><header class="odoc-preamble"><h1>Module <code><span>Iostream__In</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Iostream__In_buf (iostream.Iostream__In_buf)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">iostream</a> &#x00BB; Iostream__In_buf</nav><header class="odoc-preamble"><h1>Module <code><span>Iostream__In_buf</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

Some files were not shown because too many files have changed in this diff Show more