blob: 3c706d80ff6fddf0b78f88f83016002218ed0cb0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
[](https://crates.io/crates/dirs-sys-next)
[](https://docs.rs/dirs-sys-next/)
# `dirs-sys-next`
**NOTE**: This crate is a fork of once-abandoned `dirs-sys` crate.
_Do not use this library directly, use [`dirs-next`] or [`directories-next`]._
## Compatibility
This crate only exists to facilitate code sharing between [`dirs-next`]
and [`directories-next`].
There are no compatibility guarantees whatsoever.
Functions may change or disappear without warning or any kind of deprecation period.
## Platforms
This library is written in Rust, and supports Linux, Redox, macOS and Windows.
Other platforms are also supported; they use the Linux conventions.
## Minimum Rust version policy
The minimal required version of Rust is `1.34.0`^.
We may bump the Rust version in major and minor releases (`x`/`y` in `x.y.z`).
Changing the Rust version will be written in the CHANGELOG.
^ Except for Redox, where the Rust version depends on the
[`redox_users`](https://crates.io/crates/redox_users) crate.
## Build
It's possible to cross-compile this library if the necessary toolchains are installed with rustup.
This is helpful to ensure a change has not broken compilation on a different platform.
The following commands will build this library on Linux, macOS and Windows:
```console
cargo build --target=x86_64-unknown-linux-gnu
cargo build --target=x86_64-pc-windows-gnu
cargo build --target=x86_64-apple-darwin
cargo build --target=x86_64-unknown-redox
```
## License
Licensed under either of
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
[`dirs-next`]: https://github.com/xdg-rs/dirs
[`directories-next`]: https://github.com/xdg-rs/dirs/tree/master/directories
|
