<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/tools/rustc-std-workspace-core/README.md - fork/rust @ 1.41.0</title>
<meta name="description" content="src/tools/rustc-std-workspace-core/README.md in fork/rust at 1.41.0.">
<meta property="og:title" content="src/tools/rustc-std-workspace-core/README.md - fork/rust @ 1.41.0">
<meta property="og:description" content="src/tools/rustc-std-workspace-core/README.md in fork/rust at 1.41.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="1.41.0" data-tip="5e1a799842ba6ed4a57e91f7ab9435947482f7d8">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="5e1a799842ba6ed4a57e91f7ab9435947482f7d8">Auto merge of #68568 - pietroalbini:stable-next, r=pietroalbini</span><span class="snapshot-sha sha" data-commit="5e1a799842ba6ed4a57e91f7ab9435947482f7d8">5e1a799842b</span><time datetime="2020-01-27T15:30:31+00:00" title="2020-01-27 15:30:31 +0000">2020-01-27</time></p>
<header class="topbar"><details class="switcher"><summary>1.41.0</summary><div class="menu"><strong>branches</strong><a href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a class="current" href="/fork/rust/ref/1.41.0/">1.41.0</a><a href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <a href="/fork/rust/ref/1.41.0/tree/src/">src</a> / <a href="/fork/rust/ref/1.41.0/tree/src/tools/">tools</a> / <a href="/fork/rust/ref/1.41.0/tree/src/tools/rustc-std-workspace-core/">rustc-std-workspace-core</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.1 KiB</span><span>29 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/9c2b1fa91d3b3ed5c5cbbb7656404c0cb0ff1064/src/tools/rustc-std-workspace-core/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>The <code>rustc-std-workspace-core</code> crate</h1>
<p>This crate is a shim and empty crate which simply depends on <code>libcore</code> and
reexports all of its contents. The crate is the crux of empowering the standard
library to depend on crates from crates.io</p>
<p>Crates on crates.io that the standard library depend on the
<code>rustc-std-workspace-core</code> crate from crates.io. On crates.io, however, this
crate is empty. We use <code>[patch]</code> to override it to this crate in this
repository. As a result, crates on crates.io will draw a dependency edge to
<code>libcore</code>, the version defined in this repository. That should draw all the
dependency edges to ensure Cargo builds crates successfully!</p>
<p>Note that crates on crates.io need to depend on this crate with the name <code>core</code>
for everything to work correctly. To do that they can use:</p>
<pre class="language-toml"><a-pr>core</a-pr> <a-o>=</a-o> <a-p>{</a-p> <a-pr>version</a-pr> <a-o>=</a-o> <a-s>&quot;1.0.0&quot;</a-s><a-p>,</a-p> <a-pr>optional</a-pr> <a-o>=</a-o> <a-co>true</a-co><a-p>,</a-p> <a-pr>package</a-pr> <a-o>=</a-o> <a-s>&#39;rustc-std-workspace-core&#39;</a-s> <a-p>}</a-p></pre>
<p>Through the use of the <code>package</code> key the crate is renamed to <code>core</code>, meaning
it'll look like</p>
<pre>--extern core=.../librustc_std_workspace_core-XXXXXXX.rlib
</pre>
<p>when Cargo invokes the compiler, satisfying the implicit <code>extern crate core</code>
directive injected by the compiler.</p>
</section><div class="code-panel"><pre class="code src" data-hl="src/tools/rustc-std-workspace-core/README.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"># The `rustc-std-workspace-core` crate</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">This crate is a shim and empty crate which simply depends on `libcore` and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">reexports all of its contents. The crate is the crux of empowering the standard</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">library to depend on crates from crates.io</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">Crates on crates.io that the standard library depend on the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">`rustc-std-workspace-core` crate from crates.io. On crates.io, however, this</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">crate is empty. We use `[patch]` to override it to this crate in this</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">repository. As a result, crates on crates.io will draw a dependency edge to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">`libcore`, the version defined in this repository. That should draw all the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">dependency edges to ensure Cargo builds crates successfully!</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">Note that crates on crates.io need to depend on this crate with the name `core`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">for everything to work correctly. To do that they can use:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">```toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">core = { version = &quot;1.0.0&quot;, optional = true, package = 'rustc-std-workspace-core' }</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">Through the use of the `package` key the crate is renamed to `core`, meaning</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">it'll look like</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">--extern core=.../librustc_std_workspace_core-XXXXXXX.rlib</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">when Cargo invokes the compiler, satisfying the implicit `extern crate core`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">directive injected by the compiler.</span></span></pre></div></div>
</main>
</body>
</html>
