ocaml-containers/3.12/containers/Containers_pp/Ext/index.html
2023-06-01 16:44:06 -04:00

2 lines
No EOL
2.4 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ext (containers.Containers_pp.Ext)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">containers</a> &#x00BB; <a href="../index.html">Containers_pp</a> &#x00BB; Ext</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_pp.Ext</span></code></h1><p>Extension node.</p><p>Custom nodes can be used to add user-defined behavior to the rendered output. For example, documents might be annotated with ANSI-terminal colors, or with HTML tags.</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><span> = </span><span>{</span></code><ol><li id="type-t.pre" class="def record field anchored"><a href="#type-t.pre" class="anchor"></a><code><span>pre : <span><a href="../Out/index.html#type-t">Out.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Printed before the wrapped value.</p><span class="comment-delim">*)</span></div></li><li id="type-t.post" class="def record field anchored"><a href="#type-t.post" class="anchor"></a><code><span>post : <span><a href="../Out/index.html#type-t">Out.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Printed after the wrapped value.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>An extension is a custom document node. It takes a value of type <code>'a</code>, and a document <code>d</code>, and can output what it wants based on the custom value before and after <code>d</code> is printed.</p><p>The extension is considered to have width <code>0</code>.</p></div></div></div></body></html>