<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>credential/cargo-credential/README.md - fork/cargo @ home-0.5.12</title>
<meta name="description" content="credential/cargo-credential/README.md in fork/cargo at home-0.5.12.">
<meta property="og:title" content="credential/cargo-credential/README.md - fork/cargo @ home-0.5.12">
<meta property="og:description" content="credential/cargo-credential/README.md in fork/cargo at home-0.5.12.">
<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="home-0.5.12" data-tip="4f15cc8882fb34bf70c945e9c8ae91d6c8c91757">
<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/cargo</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/cargo</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="2652990f5f37c14545bfca387ae5cf38296fae94">Auto merge of #14600 - epage:charter-crates, r=weihanglo</span><span class="snapshot-sha sha" data-commit="2652990f5f37c14545bfca387ae5cf38296fae94">2652990f5</span><time datetime="2024-10-02T18:58:49+00:00" title="2024-10-02 18:58:49 +0000">2024-10-02</time></p>
<header class="topbar"><details class="switcher"><summary>home-0.5.12</summary><div class="menu"><strong>branches</strong><a href="/fork/cargo/ref/master/">master</a><strong>tags</strong><a href="/fork/cargo/ref/0.87.0/">0.87.0</a><a href="/fork/cargo/ref/0.88.0/">0.88.0</a><a href="/fork/cargo/ref/0.89.0/">0.89.0</a><a href="/fork/cargo/ref/0.90.0/">0.90.0</a><a href="/fork/cargo/ref/0.91.0/">0.91.0</a><a href="/fork/cargo/ref/0.92.0/">0.92.0</a><a href="/fork/cargo/ref/0.93.0/">0.93.0</a><a class="current" href="/fork/cargo/ref/home-0.5.12/">home-0.5.12</a><a class="all" href="/fork/cargo/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/cargo/">cargo</a> / <a href="/fork/cargo/ref/home-0.5.12/tree/credential/">credential</a> / <a href="/fork/cargo/ref/home-0.5.12/tree/credential/cargo-credential/">cargo-credential</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.1 KiB</span><span>44 lines</span></span><span class="actions"><a class="raw" href="/fork/cargo/raw/8e4c9f94e74aa90fa3535d29533be4d99fa1ef82/credential/cargo-credential/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>cargo-credential</h1>
<p>This package is a library to assist writing a Cargo credential helper, which
provides an interface to store tokens for authorizing access to a registry
such as https://crates.io/.</p>
<p>Documentation about credential processes may be found at
https://doc.rust-lang.org/nightly/cargo/reference/credential-provider-protocol.html</p>
<p>Example implementations may be found at
https://github.com/rust-lang/cargo/tree/master/credential</p>
<blockquote>
<p>This crate is maintained by the Cargo team for use by the wider
ecosystem. This crate follows semver compatibility for its APIs.</p>
</blockquote>
<h2>Usage</h2>
<p>Create a Cargo project with this as a dependency:</p>
<pre class="language-toml"><a-c># Add this to your Cargo.toml:</a-c>

<a-p>[</a-p><a-pr>dependencies</a-pr><a-p>]</a-p>
<a-pr>cargo-credential</a-pr> <a-o>=</a-o> <a-s>&quot;0.4&quot;</a-s></pre>
<p>And then include a <code>main.rs</code> binary which implements the <code>Credential</code> trait, and calls
the <code>main</code> function which will call the appropriate method of the trait:</p>
<pre class="language-rust"><a-c>// src/main.rs</a-c>

<a-k>use</a-k> cargo_credential<a-p>::{</a-p><a-cr>Credential</a-cr><a-p>,</a-p> <a-cr>Error</a-cr><a-p>};</a-p>

<a-k>struct</a-k> <a-t>MyCredential</a-t><a-p>;</a-p>

<a-k>impl</a-k> <a-t>Credential</a-t> <a-k>for</a-k> <a-t>MyCredential</a-t> <a-p>{</a-p>
    <a-c>/// implement trait methods here...
</a-c><a-p>}</a-p>

<a-k>fn</a-k> <a-f>main</a-f><a-p>()</a-p> <a-p>{</a-p>
    cargo_credential<a-p>::</a-p><a-f>main</a-f><a-p>(</a-p><a-cr>MyCredential</a-cr><a-p>);</a-p>
<a-p>}</a-p></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>cargo-credential</a-tt></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 package is a library to assist writing a Cargo credential helper, which</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">provides an interface to store tokens for authorizing access to a registry</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">such as https://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">Documentation about credential processes may be found at</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">https://doc.rust-lang.org/nightly/cargo/reference/credential-provider-protocol.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">Example implementations may be found at</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">https://github.com/rust-lang/cargo/tree/master/credential</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>&gt; </a-p>This crate is maintained by the Cargo team for use by the wider</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>&gt; </a-p>ecosystem. This crate follows semver compatibility for its APIs.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>##</a-p> <a-tt>Usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">Create a Cargo project with this as a dependency:</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"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p># Add this to your Cargo.toml:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>[</a-p><a-pr>dependencies</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>cargo-credential </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0.4&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>```</a-p></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"><a-p>And then include a `main.rs` binary which implements the `Credential` trait, and calls</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>the `main` function which will call the appropriate method of the trait:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>// src/main.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>use cargo_credential::{</a-p><a-cr>Credential</a-cr><a-p>, </a-p><a-cr>Error</a-cr><a-p>};</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>struct </a-p><a-t>MyCredential</a-t><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>impl </a-p><a-t>Credential</a-t><a-p> </a-p><a-k>for</a-k><a-p> </a-p><a-t>MyCredential</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>    </a-p><a-c>/// implement trait methods here...</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>fn </a-p><a-f>main</a-f><a-p>() {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>    cargo_credential::</a-p><a-f>main</a-f><a-p>(</a-p><a-cr>MyCredential</a-cr><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
