|
|
<!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="This crate provides a safe and simple cross platform way to determine whether two file paths refer to the same file or directory."><title>same_file - 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="same_file" 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="../same_file/index.html">same_file</a><span class="version">1.0.6</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="#structs">Structs</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="../same_file/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="#">same_file</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/same_file/lib.rs.html#1-572">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>This crate provides a safe and simple <strong>cross platform</strong> way to determine
|
|
|
whether two file paths refer to the same file or directory.</p>
|
|
|
<p>Most uses of this crate should be limited to the top-level <a href="fn.is_same_file.html"><code>is_same_file</code></a>
|
|
|
function, which takes two file paths and returns true if they refer to the
|
|
|
same file or directory:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>same_file::is_same_file;
|
|
|
|
|
|
<span class="macro">assert!</span>(is_same_file(<span class="string">"/bin/sh"</span>, <span class="string">"/usr/bin/sh"</span>)<span class="question-mark">?</span>);</code></pre></div>
|
|
|
<p>Additionally, this crate provides a <a href="struct.Handle.html"><code>Handle</code></a> type that permits a more efficient
|
|
|
equality check depending on your access pattern. For example, if one wanted to
|
|
|
check whether any path in a list of paths corresponded to the process’ stdout
|
|
|
handle, then one could build a handle once for stdout. The equality check for
|
|
|
each file in the list then only requires one stat call instead of two. The code
|
|
|
might look like this:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>same_file::Handle;
|
|
|
|
|
|
<span class="kw">let </span>candidates = <span class="kw-2">&</span>[
|
|
|
<span class="string">"examples/is_same_file.rs"</span>,
|
|
|
<span class="string">"examples/is_stderr.rs"</span>,
|
|
|
<span class="string">"examples/stderr"</span>,
|
|
|
];
|
|
|
<span class="kw">let </span>stdout_handle = Handle::stdout()<span class="question-mark">?</span>;
|
|
|
<span class="kw">for </span>candidate <span class="kw">in </span>candidates {
|
|
|
<span class="kw">let </span>handle = Handle::from_path(candidate)<span class="question-mark">?</span>;
|
|
|
<span class="kw">if </span>stdout_handle == handle {
|
|
|
<span class="macro">println!</span>(<span class="string">"{:?} is stdout!"</span>, candidate);
|
|
|
} <span class="kw">else </span>{
|
|
|
<span class="macro">println!</span>(<span class="string">"{:?} is NOT stdout!"</span>, candidate);
|
|
|
}
|
|
|
}</code></pre></div>
|
|
|
<p>See <a href="https://github.com/BurntSushi/same-file/blob/master/examples/is_same_file.rs"><code>examples/is_stderr.rs</code></a> for a runnable example and compare the output of:</p>
|
|
|
<ul>
|
|
|
<li><code>cargo run --example is_stderr 2> examples/stderr</code> and</li>
|
|
|
<li><code>cargo run --example is_stderr</code>.</li>
|
|
|
</ul>
|
|
|
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Handle.html" title="struct same_file::Handle">Handle</a></div><div class="desc docblock-short">A handle to a file that can be tested for equality with other handles.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.is_same_file.html" title="fn same_file::is_same_file">is_same_file</a></div><div class="desc docblock-short">Returns true if the two file paths may correspond to the same file.</div></li></ul></section></div></main></body></html> |