Skip to content

Commit ce65d8e

Browse files
author
github-actions
committed
Generated docs for shadow/shadow@67accf1
1 parent e93f9a3 commit ce65d8e

File tree

1,377 files changed

+59491
-41369
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,377 files changed

+59491
-41369
lines changed

docs/rust/allocator_api2/all.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!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><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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-6c3ea77c.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="allocator_api2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0 (05f9846f8 2025-03-31)" data-channel="1.86.0" data-search-js="search-581efc7a.js" data-settings-js="settings-6dad6058.js" ><script src="../static.files/storage-3a5871a4.js"></script><script defer src="../static.files/main-4d63596a.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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="../allocator_api2/index.html">allocator_<wbr>api2</a><span class="version">0.2.21</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#macros">Crate Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="alloc/struct.AllocError.html">alloc::AllocError</a></li><li><a href="alloc/struct.Global.html">alloc::Global</a></li><li><a href="alloc/struct.Layout.html">alloc::Layout</a></li><li><a href="alloc/struct.LayoutError.html">alloc::LayoutError</a></li><li><a href="boxed/struct.Box.html">boxed::Box</a></li><li><a href="collections/struct.TryReserveError.html">collections::TryReserveError</a></li><li><a href="vec/struct.Drain.html">vec::Drain</a></li><li><a href="vec/struct.IntoIter.html">vec::IntoIter</a></li><li><a href="vec/struct.Splice.html">vec::Splice</a></li><li><a href="vec/struct.Vec.html">vec::Vec</a></li></ul><h3 id="enums">Enums</h3><ul class="all-items"><li><a href="collections/enum.TryReserveErrorKind.html">collections::TryReserveErrorKind</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="trait.SliceExt.html">SliceExt</a></li><li><a href="alloc/trait.Allocator.html">alloc::Allocator</a></li><li><a href="alloc/trait.GlobalAlloc.html">alloc::GlobalAlloc</a></li></ul><h3 id="macros">Macros</h3><ul class="all-items"><li><a href="macro.unsize_box.html">unsize_box</a></li><li><a href="macro.vec.html">vec</a></li></ul><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="alloc/fn.alloc.html">alloc::alloc</a></li><li><a href="alloc/fn.alloc_zeroed.html">alloc::alloc_zeroed</a></li><li><a href="alloc/fn.dealloc.html">alloc::dealloc</a></li><li><a href="alloc/fn.handle_alloc_error.html">alloc::handle_alloc_error</a></li><li><a href="alloc/fn.realloc.html">alloc::realloc</a></li></ul></section></div></main></body></html>
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!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="Allocates memory with the global allocator."><title>alloc in allocator_api2::alloc - 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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-6c3ea77c.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="allocator_api2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0 (05f9846f8 2025-03-31)" data-channel="1.86.0" data-search-js="search-581efc7a.js" data-settings-js="settings-6dad6058.js" ><script src="../../static.files/storage-3a5871a4.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-4d63596a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../allocator_api2/index.html">allocator_<wbr>api2</a><span class="version">0.2.21</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">alloc</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In allocator_<wbr>api2::<wbr>alloc</a></h2></div></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"><div class="rustdoc-breadcrumbs"><a href="../index.html">allocator_api2</a>::<wbr><a href="index.html">alloc</a></div><h1>Function <span class="fn">alloc</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><span class="since" title="Stable since Rust version 1.28.0">1.28.0</span> · <a class="src" href="https://doc.rust-lang.org/1.86.0/src/alloc/alloc.rs.html#90">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn alloc(layout: <a class="struct" href="struct.Layout.html" title="struct allocator_api2::alloc::Layout">Layout</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.86.0/core/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.86.0/core/primitive.u8.html">u8</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Allocates memory with the global allocator.</p>
2+
<p>This function forwards calls to the <a href="trait.GlobalAlloc.html#tymethod.alloc" title="method allocator_api2::alloc::GlobalAlloc::alloc"><code>GlobalAlloc::alloc</code></a> method
3+
of the allocator registered with the <code>#[global_allocator]</code> attribute
4+
if there is one, or the <code>std</code> crate’s default.</p>
5+
<p>This function is expected to be deprecated in favor of the <code>allocate</code> method
6+
of the <a href="https://doc.rust-lang.org/1.86.0/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global"><code>Global</code></a> type when it and the <a href="https://doc.rust-lang.org/1.86.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator"><code>Allocator</code></a> trait become stable.</p>
7+
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
8+
<p>See <a href="trait.GlobalAlloc.html#tymethod.alloc" title="method allocator_api2::alloc::GlobalAlloc::alloc"><code>GlobalAlloc::alloc</code></a>.</p>
9+
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
10+
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::alloc::{alloc, dealloc, handle_alloc_error, Layout};
11+
12+
<span class="kw">unsafe </span>{
13+
<span class="kw">let </span>layout = Layout::new::&lt;u16&gt;();
14+
<span class="kw">let </span>ptr = alloc(layout);
15+
<span class="kw">if </span>ptr.is_null() {
16+
handle_alloc_error(layout);
17+
}
18+
19+
<span class="kw-2">*</span>(ptr <span class="kw">as </span><span class="kw-2">*mut </span>u16) = <span class="number">42</span>;
20+
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>(ptr <span class="kw">as </span><span class="kw-2">*mut </span>u16), <span class="number">42</span>);
21+
22+
dealloc(ptr, layout);
23+
}</code></pre></div>
24+
</div></details></section></div></main></body></html>
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!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="Allocates zero-initialized memory with the global allocator."><title>alloc_zeroed in allocator_api2::alloc - 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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-6c3ea77c.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="allocator_api2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0 (05f9846f8 2025-03-31)" data-channel="1.86.0" data-search-js="search-581efc7a.js" data-settings-js="settings-6dad6058.js" ><script src="../../static.files/storage-3a5871a4.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-4d63596a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../allocator_api2/index.html">allocator_<wbr>api2</a><span class="version">0.2.21</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">alloc_<wbr>zeroed</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In allocator_<wbr>api2::<wbr>alloc</a></h2></div></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"><div class="rustdoc-breadcrumbs"><a href="../index.html">allocator_api2</a>::<wbr><a href="index.html">alloc</a></div><h1>Function <span class="fn">alloc_zeroed</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><span class="since" title="Stable since Rust version 1.28.0">1.28.0</span> · <a class="src" href="https://doc.rust-lang.org/1.86.0/src/alloc/alloc.rs.html#173">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn alloc_zeroed(layout: <a class="struct" href="struct.Layout.html" title="struct allocator_api2::alloc::Layout">Layout</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.86.0/core/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.86.0/core/primitive.u8.html">u8</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Allocates zero-initialized memory with the global allocator.</p>
2+
<p>This function forwards calls to the <a href="trait.GlobalAlloc.html#method.alloc_zeroed" title="method allocator_api2::alloc::GlobalAlloc::alloc_zeroed"><code>GlobalAlloc::alloc_zeroed</code></a> method
3+
of the allocator registered with the <code>#[global_allocator]</code> attribute
4+
if there is one, or the <code>std</code> crate’s default.</p>
5+
<p>This function is expected to be deprecated in favor of the <code>allocate_zeroed</code> method
6+
of the <a href="https://doc.rust-lang.org/1.86.0/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global"><code>Global</code></a> type when it and the <a href="https://doc.rust-lang.org/1.86.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator"><code>Allocator</code></a> trait become stable.</p>
7+
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
8+
<p>See <a href="trait.GlobalAlloc.html#method.alloc_zeroed" title="method allocator_api2::alloc::GlobalAlloc::alloc_zeroed"><code>GlobalAlloc::alloc_zeroed</code></a>.</p>
9+
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
10+
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::alloc::{alloc_zeroed, dealloc, handle_alloc_error, Layout};
11+
12+
<span class="kw">unsafe </span>{
13+
<span class="kw">let </span>layout = Layout::new::&lt;u16&gt;();
14+
<span class="kw">let </span>ptr = alloc_zeroed(layout);
15+
<span class="kw">if </span>ptr.is_null() {
16+
handle_alloc_error(layout);
17+
}
18+
19+
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>(ptr <span class="kw">as </span><span class="kw-2">*mut </span>u16), <span class="number">0</span>);
20+
21+
dealloc(ptr, layout);
22+
}</code></pre></div>
23+
</div></details></section></div></main></body></html>
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!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="Deallocates memory with the global allocator."><title>dealloc in allocator_api2::alloc - 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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-6c3ea77c.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="allocator_api2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0 (05f9846f8 2025-03-31)" data-channel="1.86.0" data-search-js="search-581efc7a.js" data-settings-js="settings-6dad6058.js" ><script src="../../static.files/storage-3a5871a4.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-4d63596a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../allocator_api2/index.html">allocator_<wbr>api2</a><span class="version">0.2.21</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">dealloc</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In allocator_<wbr>api2::<wbr>alloc</a></h2></div></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"><div class="rustdoc-breadcrumbs"><a href="../index.html">allocator_api2</a>::<wbr><a href="index.html">alloc</a></div><h1>Function <span class="fn">dealloc</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><span class="since" title="Stable since Rust version 1.28.0">1.28.0</span> · <a class="src" href="https://doc.rust-lang.org/1.86.0/src/alloc/alloc.rs.html#115">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn dealloc(ptr: <a class="primitive" href="https://doc.rust-lang.org/1.86.0/core/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.86.0/core/primitive.u8.html">u8</a>, layout: <a class="struct" href="struct.Layout.html" title="struct allocator_api2::alloc::Layout">Layout</a>)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deallocates memory with the global allocator.</p>
2+
<p>This function forwards calls to the <a href="trait.GlobalAlloc.html#tymethod.dealloc" title="method allocator_api2::alloc::GlobalAlloc::dealloc"><code>GlobalAlloc::dealloc</code></a> method
3+
of the allocator registered with the <code>#[global_allocator]</code> attribute
4+
if there is one, or the <code>std</code> crate’s default.</p>
5+
<p>This function is expected to be deprecated in favor of the <code>deallocate</code> method
6+
of the <a href="https://doc.rust-lang.org/1.86.0/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global"><code>Global</code></a> type when it and the <a href="https://doc.rust-lang.org/1.86.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator"><code>Allocator</code></a> trait become stable.</p>
7+
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
8+
<p>See <a href="trait.GlobalAlloc.html#tymethod.dealloc" title="method allocator_api2::alloc::GlobalAlloc::dealloc"><code>GlobalAlloc::dealloc</code></a>.</p>
9+
</div></details></section></div></main></body></html>

0 commit comments

Comments
 (0)