Skip to content

Commit

Permalink
deploy: 14f6865
Browse files Browse the repository at this point in the history
  • Loading branch information
@artichoke-ci
artichoke-ci committed Jan 2, 2024
0 parents commit 3793078
Show file tree
Hide file tree
Showing 268 changed files with 53,665 additions and 0 deletions.
Empty file added .lock
Empty file.
Empty file added .nojekyll
Empty file.
2 changes: 2 additions & 0 deletions bstr/all.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!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="List of all items in this crate"><title>List of all items in this crate</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-bf502f66ec635d5d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bstr" data-themes="" data-resource-suffix="" data-rustdoc-version="1.77.0-nightly (e51e98dde 2023-12-31)" data-channel="nightly" data-search-js="search-c17e98913a53b3b7.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../static.files/main-0b2e2def73e61cbe.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.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 sys"><!--[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="../bstr/index.html">bstr</a><span class="version">1.9.0</span></h2></div><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></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="../bstr/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"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.BStr.html">BStr</a></li><li><a href="struct.Bytes.html">Bytes</a></li><li><a href="struct.CharIndices.html">CharIndices</a></li><li><a href="struct.Chars.html">Chars</a></li><li><a href="struct.EscapeBytes.html">EscapeBytes</a></li><li><a href="struct.FieldsWith.html">FieldsWith</a></li><li><a href="struct.Find.html">Find</a></li><li><a href="struct.FindReverse.html">FindReverse</a></li><li><a href="struct.Finder.html">Finder</a></li><li><a href="struct.FinderReverse.html">FinderReverse</a></li><li><a href="struct.Lines.html">Lines</a></li><li><a href="struct.LinesWithTerminator.html">LinesWithTerminator</a></li><li><a href="struct.Split.html">Split</a></li><li><a href="struct.SplitN.html">SplitN</a></li><li><a href="struct.SplitNReverse.html">SplitNReverse</a></li><li><a href="struct.SplitReverse.html">SplitReverse</a></li><li><a href="struct.Utf8Chunk.html">Utf8Chunk</a></li><li><a href="struct.Utf8Chunks.html">Utf8Chunks</a></li><li><a href="struct.Utf8Error.html">Utf8Error</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="trait.ByteSlice.html">ByteSlice</a></li></ul><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="fn.B.html">B</a></li><li><a href="fn.decode_last_utf8.html">decode_last_utf8</a></li><li><a href="fn.decode_utf8.html">decode_utf8</a></li></ul></section></div></main></body></html>
11 changes: 11 additions & 0 deletions bstr/bstr/struct.BStr.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.BStr.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.BStr.html">../../bstr/struct.BStr.html</a>...</p>
<script>location.replace("../../bstr/struct.BStr.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/escape_bytes/struct.EscapeBytes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.EscapeBytes.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.EscapeBytes.html">../../bstr/struct.EscapeBytes.html</a>...</p>
<script>location.replace("../../bstr/struct.EscapeBytes.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/fn.B.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/fn.B.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/fn.B.html">../../bstr/fn.B.html</a>...</p>
<script>location.replace("../../bstr/fn.B.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.Bytes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.Bytes.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.Bytes.html">../../bstr/struct.Bytes.html</a>...</p>
<script>location.replace("../../bstr/struct.Bytes.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.FieldsWith.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.FieldsWith.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.FieldsWith.html">../../bstr/struct.FieldsWith.html</a>...</p>
<script>location.replace("../../bstr/struct.FieldsWith.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.Find.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.Find.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.Find.html">../../bstr/struct.Find.html</a>...</p>
<script>location.replace("../../bstr/struct.Find.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.FindReverse.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.FindReverse.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.FindReverse.html">../../bstr/struct.FindReverse.html</a>...</p>
<script>location.replace("../../bstr/struct.FindReverse.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.Finder.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.Finder.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.Finder.html">../../bstr/struct.Finder.html</a>...</p>
<script>location.replace("../../bstr/struct.Finder.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.FinderReverse.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.FinderReverse.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.FinderReverse.html">../../bstr/struct.FinderReverse.html</a>...</p>
<script>location.replace("../../bstr/struct.FinderReverse.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.Lines.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.Lines.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.Lines.html">../../bstr/struct.Lines.html</a>...</p>
<script>location.replace("../../bstr/struct.Lines.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.LinesWithTerminator.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.LinesWithTerminator.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.LinesWithTerminator.html">../../bstr/struct.LinesWithTerminator.html</a>...</p>
<script>location.replace("../../bstr/struct.LinesWithTerminator.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.Split.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.Split.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.Split.html">../../bstr/struct.Split.html</a>...</p>
<script>location.replace("../../bstr/struct.Split.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.SplitN.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.SplitN.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.SplitN.html">../../bstr/struct.SplitN.html</a>...</p>
<script>location.replace("../../bstr/struct.SplitN.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.SplitNReverse.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.SplitNReverse.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.SplitNReverse.html">../../bstr/struct.SplitNReverse.html</a>...</p>
<script>location.replace("../../bstr/struct.SplitNReverse.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/struct.SplitReverse.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/struct.SplitReverse.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/struct.SplitReverse.html">../../bstr/struct.SplitReverse.html</a>...</p>
<script>location.replace("../../bstr/struct.SplitReverse.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions bstr/ext_slice/trait.ByteSlice.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bstr/trait.ByteSlice.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bstr/trait.ByteSlice.html">../../bstr/trait.ByteSlice.html</a>...</p>
<script>location.replace("../../bstr/trait.ByteSlice.html" + location.search + location.hash);</script>
</body>
</html>
32 changes: 32 additions & 0 deletions bstr/fn.B.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!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="A short-hand constructor for building a `&amp;[u8]`."><title>B in bstr - 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-bf502f66ec635d5d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bstr" data-themes="" data-resource-suffix="" data-rustdoc-version="1.77.0-nightly (e51e98dde 2023-12-31)" data-channel="nightly" data-search-js="search-c17e98913a53b3b7.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-0b2e2def73e61cbe.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.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 fn"><!--[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="../bstr/index.html">bstr</a><span class="version">1.9.0</span></h2></div><div class="sidebar-elems"></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="../bstr/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>Function <a href="index.html">bstr</a>::<wbr><a class="fn" href="#">B</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/bstr/ext_slice.rs.html#75-77">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn B&lt;'a, B: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]&gt;&gt;(bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a B</a>) -&gt; &amp;'a [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>] <a href="#" class="tooltip" data-notable-ty="&amp;&#39;a [u8]">ⓘ</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A short-hand constructor for building a <code>&amp;[u8]</code>.</p>
<p>This idiosyncratic constructor is useful for concisely building byte string
slices. Its primary utility is in conveniently writing byte string literals
in a uniform way. For example, consider this code that does not compile:</p>

<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>strs = <span class="macro">vec!</span>[<span class="string">b"a"</span>, <span class="string">b"xy"</span>];</code></pre></div>
<p>The above code doesn’t compile because the type of the byte string literal
<code>b&quot;a&quot;</code> is <code>&amp;'static [u8; 1]</code>, and the type of <code>b&quot;xy&quot;</code> is
<code>&amp;'static [u8; 2]</code>. Since their types aren’t the same, they can’t be stored
in the same <code>Vec</code>. (This is dissimilar from normal Unicode string slices,
where both <code>&quot;a&quot;</code> and <code>&quot;xy&quot;</code> have the same type of <code>&amp;'static str</code>.)</p>
<p>One way of getting the above code to compile is to convert byte strings to
slices. You might try this:</p>

<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>strs = <span class="macro">vec!</span>[<span class="kw-2">&amp;</span><span class="string">b"a"</span>, <span class="kw-2">&amp;</span><span class="string">b"xy"</span>];</code></pre></div>
<p>But this just creates values with type <code>&amp; &amp;'static [u8; 1]</code> and
<code>&amp; &amp;'static [u8; 2]</code>. Instead, you need to force the issue like so:</p>

<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>strs = <span class="macro">vec!</span>[<span class="kw-2">&amp;</span><span class="string">b"a"</span>[..], <span class="kw-2">&amp;</span><span class="string">b"xy"</span>[..]];
<span class="comment">// or
</span><span class="kw">let </span>strs = <span class="macro">vec!</span>[<span class="string">b"a"</span>.as_ref(), <span class="string">b"xy"</span>.as_ref()];</code></pre></div>
<p>But neither of these are particularly convenient to type, especially when
it’s something as common as a string literal. Thus, this constructor
permits writing the following instead:</p>

<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bstr::B;

<span class="kw">let </span>strs = <span class="macro">vec!</span>[B(<span class="string">"a"</span>), B(<span class="string">b"xy"</span>)];</code></pre></div>
<p>Notice that this also lets you mix and match both string literals and byte
string literals. This can be quite convenient!</p>
</div></details><script type="text/json" id="notable-traits-data">{"&'a [u8]":"<h3>Notable traits for <code>&amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</div>"}</script></section></div></main></body></html>
Loading

0 comments on commit 3793078

Please sign in to comment.