mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 00:18:24 +00:00
19 lines
5.6 KiB
HTML
19 lines
5.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="Regex matchers on character and byte streams."><title>matchers - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="matchers" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><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 crate"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../matchers/index.html">matchers</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">matchers</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/matchers/lib.rs.html#1-600">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>Regex matchers on character and byte streams.</p>
|
|
<h3 id="overview"><a class="doc-anchor" href="#overview">§</a>Overview</h3>
|
|
<p>The <a href="https://crates.io/crates/regex"><code>regex</code></a> crate implements regular expression matching on strings and byte
|
|
arrays. However, in order to match the output of implementations of <code>fmt::Debug</code>
|
|
and <code>fmt::Display</code>, or by any code which writes to an instance of <code>fmt::Write</code>
|
|
or <code>io::Write</code>, it is necessary to first allocate a buffer, write to that
|
|
buffer, and then match the buffer against a regex.</p>
|
|
<p>In cases where it is not necessary to extract substrings, but only to test whether
|
|
or not output matches a regex, it is not strictly necessary to allocate and
|
|
write this output to a buffer. This crate provides a simple interface on top of
|
|
the lower-level <a href="https://crates.io/crates/regex-automata"><code>regex-automata</code></a> library that implements <code>fmt::Write</code> and
|
|
<code>io::Write</code> for regex patterns. This may be used to test whether streaming
|
|
output matches a pattern without buffering that output.</p>
|
|
<p>Users who need to extract substrings based on a pattern or who already have
|
|
buffered data should probably use the <a href="https://crates.io/crates/regex"><code>regex</code></a> crate instead.</p>
|
|
<h3 id="syntax"><a class="doc-anchor" href="#syntax">§</a>Syntax</h3>
|
|
<p>This crate uses the same <a href="https://docs.rs/regex-automata/0.1.7/regex_automata/#syntax">regex syntax</a> of the <code>regex-automata</code> crate.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Error.html" title="struct matchers::Error">Error</a></div><div class="desc docblock-short">An error that occurred during the construction of a DFA.</div></li><li><div class="item-name"><a class="struct" href="struct.Matcher.html" title="struct matchers::Matcher">Matcher</a></div><div class="desc docblock-short">A reference to a <a href="../struct.Pattern.html"><code>Pattern</code></a> that matches a single input.</div></li><li><div class="item-name"><a class="struct" href="struct.Pattern.html" title="struct matchers::Pattern">Pattern</a></div><div class="desc docblock-short">A compiled match pattern that can match multipe inputs, or return a
|
|
<a href="../struct.Matcher.html"><code>Matcher</code></a> that matches a single input.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.ToMatcher.html" title="trait matchers::ToMatcher">ToMatcher</a></div></li></ul></section></div></main></body></html> |