• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1same-file
2=========
3A safe and cross platform crate to determine whether two files or directories
4are the same.
5
6[![Build status](https://github.com/BurntSushi/same-file/workflows/ci/badge.svg)](https://github.com/BurntSushi/same-file/actions)
7[![](http://meritbadge.herokuapp.com/same-file)](https://crates.io/crates/same-file)
8
9Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
10
11### Documentation
12
13https://docs.rs/same-file
14
15### Usage
16
17Add this to your `Cargo.toml`:
18
19```toml
20[dependencies]
21same-file = "1"
22```
23
24### Example
25
26The simplest use of this crate is to use the `is_same_file` function, which
27takes two file paths and returns true if and only if they refer to the same
28file:
29
30```rust,no_run
31use same_file::is_same_file;
32
33fn main() {
34    assert!(is_same_file("/bin/sh", "/usr/bin/sh").unwrap());
35}
36```
37
38### Minimum Rust version policy
39
40This crate's minimum supported `rustc` version is `1.34.0`.
41
42The current policy is that the minimum Rust version required to use this crate
43can be increased in minor version updates. For example, if `crate 1.0` requires
44Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust
451.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum
46version of Rust.
47
48In general, this crate will be conservative with respect to the minimum
49supported version of Rust.
50