28 lines
5.6 KiB
HTML
28 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="Returns true if the given character can be escaped in a regex."><title>is_escapeable_character in regex_syntax - 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_syntax" 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 fn"><!--[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="#">is_escapeable_character</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../regex_syntax/index.html">regex_<wbr>syntax</a><span class="version">0.8.10</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">is_<wbr>escapeable_<wbr>character</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate regex_<wbr>syntax</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_syntax</a></div><h1>Function <span class="fn">is_<wbr>escapeable_<wbr>character</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_syntax/lib.rs.html#305-333">Source</a> </span></div><pre class="rust item-decl"><code>pub fn is_escapeable_character(c: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.char.html">char</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returns true if the given character can be escaped in a regex.</p>
|
|
<p>This returns true in all cases that <code>is_meta_character</code> returns true, but
|
|
also returns true in some cases where <code>is_meta_character</code> returns false.
|
|
For example, <code>%</code> is not a meta character, but it is escapable. That is,
|
|
<code>%</code> and <code>\%</code> both match a literal <code>%</code> in all contexts.</p>
|
|
<p>The purpose of this routine is to provide knowledge about what characters
|
|
may be escaped. Namely, most regex engines permit “superfluous” escapes
|
|
where characters without any special significance may be escaped even
|
|
though there is no actual <em>need</em> to do so.</p>
|
|
<p>This will return false for some characters. For example, <code>e</code> is not
|
|
escapable. Therefore, <code>\e</code> will either result in a parse error (which is
|
|
true today), or it could backwards compatibly evolve into a new construct
|
|
with its own meaning. Indeed, that is the purpose of banning <em>some</em>
|
|
superfluous escapes: it provides a way to evolve the syntax in a compatible
|
|
manner.</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>regex_syntax::is_escapeable_character;
|
|
|
|
<span class="macro">assert!</span>(is_escapeable_character(<span class="string">'?'</span>));
|
|
<span class="macro">assert!</span>(is_escapeable_character(<span class="string">'-'</span>));
|
|
<span class="macro">assert!</span>(is_escapeable_character(<span class="string">'&'</span>));
|
|
<span class="macro">assert!</span>(is_escapeable_character(<span class="string">'#'</span>));
|
|
<span class="macro">assert!</span>(is_escapeable_character(<span class="string">'%'</span>));
|
|
<span class="macro">assert!</span>(is_escapeable_character(<span class="string">'/'</span>));
|
|
<span class="macro">assert!</span>(is_escapeable_character(<span class="string">'!'</span>));
|
|
<span class="macro">assert!</span>(is_escapeable_character(<span class="string">'"'</span>));
|
|
|
|
<span class="macro">assert!</span>(!is_escapeable_character(<span class="string">'e'</span>));</code></pre></div></div></details></section></div></main></body></html> |