mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
36 lines
6.9 KiB
HTML
36 lines
6.9 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="Faster, more compact implementation of `Cow`."><title>beef - 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="beef" 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="../crates.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 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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../beef/index.html">beef</a><span class="version">0.5.2</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="#modules">Modules</a></li><li><a href="#types">Type Aliases</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="../beef/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>Crate <a class="mod" href="#">beef</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/beef/lib.rs.html#1-285">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>Faster, more compact implementation of <code>Cow</code>.</p>
|
||
<p><strong><a href="https://github.com/maciejhirsz/beef/releases">Changelog</a> -</strong>
|
||
<strong><a href="https://crates.io/crates/beef">Cargo</a> -</strong>
|
||
<strong><a href="https://github.com/maciejhirsz/beef">Repository</a></strong></p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>beef::Cow;
|
||
|
||
<span class="kw">let </span>borrowed: Cow<str> = Cow::borrowed(<span class="string">"Hello"</span>);
|
||
<span class="kw">let </span>owned: Cow<str> = Cow::owned(String::from(<span class="string">"World"</span>));
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="macro">format!</span>(<span class="string">"{} {}!"</span>, borrowed, owned),
|
||
<span class="string">"Hello World!"</span>,
|
||
);</code></pre></div>
|
||
<p>There are two versions of <code>Cow</code> exposed by this crate:</p>
|
||
<ul>
|
||
<li><code>beef::Cow</code> is 3 words wide: pointer, length, and capacity. It stores the ownership tag in capacity.</li>
|
||
<li><code>beef::lean::Cow</code> is 2 words wide, storing length, capacity, and the ownership tag all in one word.</li>
|
||
</ul>
|
||
<p>Both versions are leaner than the <code>std::borrow::Cow</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::mem::size_of;
|
||
|
||
<span class="kw">const </span>WORD: usize = size_of::<usize>();
|
||
|
||
<span class="macro">assert_eq!</span>(size_of::<std::borrow::Cow<str>>(), <span class="number">4 </span>* WORD);
|
||
<span class="macro">assert_eq!</span>(size_of::<beef::Cow<str>>(), <span class="number">3 </span>* WORD);
|
||
|
||
<span class="comment">// Lean variant is two words on 64-bit architecture
|
||
</span><span class="attr">#[cfg(target_pointer_width = <span class="string">"64"</span>)]
|
||
</span><span class="macro">assert_eq!</span>(size_of::<beef::lean::Cow<str>>(), <span class="number">2 </span>* WORD);</code></pre></div>
|
||
</div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="generic/index.html" title="mod beef::generic">generic</a></div><div class="desc docblock-short">This module contains the actual, albeit generic, implementaiton of the <code>Cow</code>,
|
||
and the traits that are available to it.</div></li><li><div class="item-name"><a class="mod" href="lean/index.html" title="mod beef::lean">lean</a></div><div class="desc docblock-short">Namespace containing the 2-word <code>Cow</code> implementation.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Cow.html" title="type beef::Cow">Cow</a></div><div class="desc docblock-short">Compact three word <code>Cow</code> that puts the ownership tag in capacity.
|
||
This is a type alias, for documentation see <a href="./generic/struct.Cow.html"><code>beef::generic::Cow</code></a>.</div></li></ul></section></div></main></body></html> |