29 lines
7.4 KiB
HTML
29 lines
7.4 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Lower level primitive types that are useful in a variety of circumstances."><title>regex_automata::util::primitives - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="regex_automata" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module primitives</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../regex_automata/index.html">regex_<wbr>automata</a><span class="version">0.4.14</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module primitives</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#overview" title="Overview">Overview</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In regex_<wbr>automata::<wbr>util</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">regex_automata</a>::<wbr><a href="../index.html">util</a></div><h1>Module <span>primitives</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/regex_automata/util/primitives.rs.html#1-776">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Lower level primitive types that are useful in a variety of circumstances.</p>
|
||
<h2 id="overview"><a class="doc-anchor" href="#overview">§</a>Overview</h2>
|
||
<p>This list represents the principle types in this module and briefly describes
|
||
when you might want to use them.</p>
|
||
<ul>
|
||
<li><a href="../../struct.PatternID.html" title="struct regex_automata::PatternID"><code>PatternID</code></a> - A type that represents the identifier of a regex pattern.
|
||
This is probably the most widely used type in this module (which is why it’s
|
||
also re-exported in the crate root).</li>
|
||
<li><a href="struct.StateID.html" title="struct regex_automata::util::primitives::StateID"><code>StateID</code></a> - A type the represents the identifier of a finite automaton
|
||
state. This is used for both NFAs and DFAs, with the notable exception of
|
||
the hybrid NFA/DFA. (The hybrid NFA/DFA uses a special purpose “lazy” state
|
||
identifier.)</li>
|
||
<li><a href="struct.SmallIndex.html" title="struct regex_automata::util::primitives::SmallIndex"><code>SmallIndex</code></a> - The internal representation of both a <code>PatternID</code> and a
|
||
<code>StateID</code>. Its purpose is to serve as a type that can index memory without
|
||
being as big as a <code>usize</code> on 64-bit targets. The main idea behind this type
|
||
is that there are many things in regex engines that will, in practice, never
|
||
overflow a 32-bit integer. (For example, like the number of patterns in a regex
|
||
or the number of states in an NFA.) Thus, a <code>SmallIndex</code> can be used to index
|
||
memory without peppering <code>as</code> casts everywhere. Moreover, it forces callers
|
||
to handle errors in the case where, somehow, the value would otherwise overflow
|
||
either a 32-bit integer or a <code>usize</code> (e.g., on 16-bit targets).</li>
|
||
<li><a href="struct.NonMaxUsize.html" title="struct regex_automata::util::primitives::NonMaxUsize"><code>NonMaxUsize</code></a> - Represents a <code>usize</code> that cannot be <code>usize::MAX</code>. As a
|
||
result, <code>Option<NonMaxUsize></code> has the same size in memory as a <code>usize</code>. This
|
||
useful, for example, when representing the offsets of submatches since it
|
||
reduces memory usage by a factor of 2. It is a legal optimization since Rust
|
||
guarantees that slices never have a length that exceeds <code>isize::MAX</code>.</li>
|
||
</ul>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.NonMaxUsize.html" title="struct regex_automata::util::primitives::NonMaxUsize">NonMax<wbr>Usize</a></dt><dd>A <code>usize</code> that can never be <code>usize::MAX</code>.</dd><dt><a class="struct" href="struct.PatternID.html" title="struct regex_automata::util::primitives::PatternID">PatternID</a></dt><dd>The identifier of a regex pattern, represented by a <a href="struct.SmallIndex.html" title="struct regex_automata::util::primitives::SmallIndex"><code>SmallIndex</code></a>.</dd><dt><a class="struct" href="struct.PatternIDError.html" title="struct regex_automata::util::primitives::PatternIDError">PatternID<wbr>Error</a></dt><dd>This error occurs when a value could not be constructed.</dd><dt><a class="struct" href="struct.SmallIndex.html" title="struct regex_automata::util::primitives::SmallIndex">Small<wbr>Index</a></dt><dd>A type that represents a “small” index.</dd><dt><a class="struct" href="struct.SmallIndexError.html" title="struct regex_automata::util::primitives::SmallIndexError">Small<wbr>Index<wbr>Error</a></dt><dd>This error occurs when a small index could not be constructed.</dd><dt><a class="struct" href="struct.StateID.html" title="struct regex_automata::util::primitives::StateID">StateID</a></dt><dd>The identifier of a finite automaton state, represented by a
|
||
<a href="struct.SmallIndex.html" title="struct regex_automata::util::primitives::SmallIndex"><code>SmallIndex</code></a>.</dd><dt><a class="struct" href="struct.StateIDError.html" title="struct regex_automata::util::primitives::StateIDError">StateID<wbr>Error</a></dt><dd>This error occurs when a value could not be constructed.</dd></dl></section></div></main></body></html> |