mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-15 12:38:23 +00:00
30 lines
8.6 KiB
HTML
30 lines
8.6 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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../regex_automata/index.html">regex_automata</a><span class="version">0.4.5</span></h2></div><h2 class="location"><a href="#">Module primitives</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In regex_automata::util</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|||
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../regex_automata/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">regex_automata</a>::<wbr><a href="../index.html">util</a>::<wbr><a class="mod" href="#">primitives</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/regex_automata/util/primitives.rs.html#1-776">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></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 href="#overview">Overview</a></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"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.NonMaxUsize.html" title="struct regex_automata::util::primitives::NonMaxUsize">NonMaxUsize</a></div><div class="desc docblock-short">A <code>usize</code> that can never be <code>usize::MAX</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatternID.html" title="struct regex_automata::util::primitives::PatternID">PatternID</a></div><div class="desc docblock-short">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>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatternIDError.html" title="struct regex_automata::util::primitives::PatternIDError">PatternIDError</a></div><div class="desc docblock-short">This error occurs when a value could not be constructed.</div></li><li><div class="item-name"><a class="struct" href="struct.SmallIndex.html" title="struct regex_automata::util::primitives::SmallIndex">SmallIndex</a></div><div class="desc docblock-short">A type that represents a “small” index.</div></li><li><div class="item-name"><a class="struct" href="struct.SmallIndexError.html" title="struct regex_automata::util::primitives::SmallIndexError">SmallIndexError</a></div><div class="desc docblock-short">This error occurs when a small index could not be constructed.</div></li><li><div class="item-name"><a class="struct" href="struct.StateID.html" title="struct regex_automata::util::primitives::StateID">StateID</a></div><div class="desc docblock-short">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>.</div></li><li><div class="item-name"><a class="struct" href="struct.StateIDError.html" title="struct regex_automata::util::primitives::StateIDError">StateIDError</a></div><div class="desc docblock-short">This error occurs when a value could not be constructed.</div></li></ul></section></div></main></body></html>
|