]>
Commit | Line | Data |
---|---|---|
3c0e092e XL |
1 | # Changelog |
2 | ||
3 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | |
4 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | |
5 | ||
f2b60f7d FG |
6 | ## [1.1.1] - 2022-08-12 |
7 | ||
8 | ### Fixed | |
9 | ||
10 | - Fixed a build regression on older nightlies in the 1.63 series | |
11 | ([#22](https://github.com/camino-rs/camino/issues/22)). | |
12 | - Documentation fixes. | |
13 | ||
14 | ## [1.1.0] - 2022-08-11 | |
15 | ||
16 | ### Added | |
17 | ||
18 | - New methods, mirroring those in recent versions of Rust: | |
19 | - `Utf8Path::try_exists` checks whether a path exists. Note that while `std::path::Path` only provides this method for Rust 1.58 and above, `camino` backfills the method for all Rust versions it supports. | |
20 | - `Utf8PathBuf::shrink_to` shrinks a `Utf8PathBuf` to a given size. This was added in, and is gated on, Rust 1.56+. | |
21 | - `Utf8PathBuf::try_reserve` and `Utf8PathBuf::try_reserve_exact` implement fallible allocations. These were added in, and are gated on, Rust 1.63+. | |
22 | - A number of `#[must_use]` annotations to APIs, mirroring those added to `Path` and `PathBuf` in recent versions of Rust. The minor version bump is due to this change. | |
23 | ||
923072b8 FG |
24 | ## [1.0.9] - 2022-05-19 |
25 | ||
26 | ### Fixed | |
27 | ||
28 | - Documentation fixes. | |
29 | ||
30 | ## [1.0.8] - 2022-05-09 | |
31 | ||
32 | ### Added | |
33 | ||
34 | - New methods `canonicalize_utf8`, `read_link_utf8` and `read_dir_utf8` return `Utf8PathBuf`s, erroring out if a resulting path is not valid UTF-8. | |
35 | - New feature `proptest1` introduces proptest `Arbitrary` impls for `Utf8PathBuf` and | |
36 | `Box<Utf8Path>` ([#18], thanks [mcronce](https://github.com/mcronce) for your first contribution!) | |
37 | ||
38 | [#18]: https://github.com/camino-rs/camino/pull/18 | |
39 | ||
5099ac24 FG |
40 | ## [1.0.7] - 2022-01-16 |
41 | ||
42 | ### Added | |
43 | ||
44 | - `Utf8Path::is_symlink` checks whether a path is a symlink. Note that while `std::path::Path` only | |
f2b60f7d | 45 | provides this method for version 1.58 and above, `camino` backfills the method for all Rust versions |
5099ac24 FG |
46 | it supports. |
47 | ||
48 | ### Changed | |
49 | ||
50 | - Update repository links to new location [camino-rs/camino](https://github.com/camino-rs/camino). | |
51 | - Update `structopt` example to clap 3's builtin derive feature. | |
52 | (camino continues to work with structopt as before.) | |
53 | ||
54 | ## [1.0.6] - 2022-01-16 | |
55 | ||
56 | (This release was yanked due to a publishing issue.) | |
57 | ||
3c0e092e XL |
58 | ## [1.0.5] - 2021-07-27 |
59 | ||
60 | ### Added | |
61 | ||
62 | - `Utf8PathBuf::into_std_path_buf` converts a `Utf8PathBuf` to a `PathBuf`; equivalent to the | |
63 | `From<Utf8PathBuf> for PathBuf` impl, but may aid in type inference. | |
64 | - `Utf8Path::as_std_path` converts a `Utf8Path` to a `Path`; equivalent to the | |
65 | `AsRef<&Path> for &Utf8Path` impl, but may aid in type inference. | |
66 | ||
67 | ## [1.0.4] - 2021-03-19 | |
68 | ||
69 | ### Fixed | |
70 | ||
71 | - `Hash` impls for `Utf8PathBuf` and `Utf8Path` now match as required by the `Borrow` contract ([#9]). | |
72 | ||
5099ac24 | 73 | [#9]: https://github.com/camino-rs/camino/issues/9 |
3c0e092e XL |
74 | |
75 | ## [1.0.3] - 2021-03-11 | |
76 | ||
77 | ### Added | |
78 | ||
79 | - `TryFrom<PathBuf> for Utf8PathBuf` and `TryFrom<&Path> for &Utf8Path`, both of which return new error types ([#6]). | |
80 | - `AsRef<Utf8Path>`, `AsRef<Path>`, `AsRef<str>` and `AsRef<OsStr>` impls for `Utf8Components`, `Utf8Component` and | |
81 | `Iter`. | |
82 | ||
5099ac24 | 83 | [#6]: https://github.com/camino-rs/camino/issues/6 |
3c0e092e XL |
84 | |
85 | ## [1.0.2] - 2021-03-02 | |
86 | ||
87 | ### Added | |
88 | ||
89 | - `From` impls for converting a `&Utf8Path` or a `Utf8PathBuf` into `Box<Path>`, `Rc<Path>`, `Arc<Path>` and `Cow<'a, Path>`. | |
90 | - `PartialEq` and `PartialOrd` implementations comparing `Utf8Path` and `Utf8PathBuf` with `Path`, `PathBuf` and its | |
91 | variants, and comparing `OsStr`, `OsString` and its variants. | |
92 | ||
93 | ## [1.0.1] - 2021-02-25 | |
94 | ||
95 | ### Added | |
96 | ||
97 | - More `PartialEq` and `PartialOrd` implementations. | |
98 | - MSRV lowered to 1.34. | |
99 | ||
100 | ## [1.0.0] - 2021-02-23 | |
101 | ||
102 | Initial release. | |
103 | ||
f2b60f7d FG |
104 | [1.1.1]: https://github.com/camino-rs/camino/releases/tag/camino-1.1.1 |
105 | [1.1.0]: https://github.com/camino-rs/camino/releases/tag/camino-1.1.0 | |
923072b8 FG |
106 | [1.0.9]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.9 |
107 | [1.0.8]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.8 | |
5099ac24 FG |
108 | [1.0.7]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.7 |
109 | [1.0.6]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.6 | |
110 | [1.0.5]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.5 | |
111 | [1.0.4]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.4 | |
112 | [1.0.3]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.3 | |
113 | [1.0.2]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.2 | |
114 | [1.0.1]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.1 | |
115 | [1.0.0]: https://github.com/camino-rs/camino/releases/tag/camino-1.0.0 |