Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tracking issue for path_ext stabilization #27725

Closed
aturon opened this issue Aug 12, 2015 · 7 comments · Fixed by #29254
Closed

Tracking issue for path_ext stabilization #27725

aturon opened this issue Aug 12, 2015 · 7 comments · Fixed by #29254
Labels
B-unstable Blocker: Implemented in the nightly compiler and unstable. final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Milestone
1.5

Comments

@aturon
Copy link
Member

aturon commented Aug 12, 2015

The PathExt trait provides a number of methods on paths that conveniently connect it to the std::fs API.

While these methods are largely fine, there is some question as to how many of them there should be; the rationale for the exact selection of methods is currently a bit muddy.

Given that the trait can grow over time with default methods, it may be worth stabilizing the portion we feel confident we want, and then adding more over time.

cc @alexcrichton @brson
@aturon aturon added T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. B-unstable Blocker: Implemented in the nightly compiler and unstable. A-io labels Aug 12, 2015
@alexcrichton
Copy link
Member

This trait was also recently tweaked to have a bit of a more coherent design, so we may just want to decide whether that strategy is appropriate or not.

@Ms2ger Ms2ger mentioned this issue Aug 16, 2015
Closed
99 tasks
@aturon
Copy link
Member Author

aturon commented Sep 23, 2015

Nominating: this should at least be discussed for possible FCP in the 1.5 cycle.

@alexcrichton
Copy link
Member

This issue is now entering its cycle-long FCP for stabilization in 1.5

On final question about this issue is whether we continue to have an extension trait or fold the functionality to inherent methods on Path. Some points of note are:

  • This provides a nice boundary for methods on Path that do I/O and not.
  • This makes it a little easier to migrate Path to libcore and PathBuf to libcollections, but it's unclear what that use case is.
  • This design pattern exists nowhere else in the standard library (e.g. an extension trait available everywhere, just requires importing the trait).

@alexcrichton alexcrichton added final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. and removed I-nominated labels Sep 24, 2015
@steveklabnik steveklabnik added this to the 1.5 milestone Oct 1, 2015
@dhardy
Copy link
Contributor

dhardy commented Oct 5, 2015

I don't know about migration to libcore, but folding into Path makes sense for most use cases (saves an import).

I'm not sure if there are any users of Path where basics like is_file() are not needed? Would Path be used for paths inside zip files or web URLs? I doubt it.

@aturon
Copy link
Member Author

aturon commented Oct 8, 2015

It's also worth noting that this trait originated when there was a separate io module hierarchy, so Path felt more "outside" of IO in some sense.

I'm increasingly convinced that treating this as an extension trait is not actually buying us anything, and winds up being a papercut for newcomers.

@retep998
Copy link
Member

I'm pretty much okay with the methods that PathExt provides and I think it would be better if the methods were simply inherent methods on Path rather than using an extension trait.

@alexcrichton
Copy link
Member

The libs team discussed this during triage today and the decision was to stabilize as inherent methods on Path.

@alexcrichton alexcrichton mentioned this issue Oct 23, 2015
Merged
alexcrichton added a commit to alexcrichton/rust that referenced this issue Oct 25, 2015
@alexcrichton
std: Stabilize library APIs for 1.5
ff49733 
This commit stabilizes and deprecates library APIs whose FCP has closed in the
last cycle, specifically:

Stabilized APIs:

* `fs::canonicalize`
* `Path::{metadata, symlink_metadata, canonicalize, read_link, read_dir, exists,
   is_file, is_dir}` - all moved to inherent methods from the `PathExt` trait.
* `Formatter::fill`
* `Formatter::width`
* `Formatter::precision`
* `Formatter::sign_plus`
* `Formatter::sign_minus`
* `Formatter::alternate`
* `Formatter::sign_aware_zero_pad`
* `string::ParseError`
* `Utf8Error::valid_up_to`
* `Iterator::{cmp, partial_cmp, eq, ne, lt, le, gt, ge}`
* `<[T]>::split_{first,last}{,_mut}`
* `Condvar::wait_timeout` - note that `wait_timeout_ms` is not yet deprecated
  but will be once 1.5 is released.
* `str::{R,}MatchIndices`
* `str::{r,}match_indices`
* `char::from_u32_unchecked`
* `VecDeque::insert`
* `VecDeque::shrink_to_fit`
* `VecDeque::as_slices`
* `VecDeque::as_mut_slices`
* `VecDeque::swap_remove_front` - (renamed from `swap_front_remove`)
* `VecDeque::swap_remove_back` - (renamed from `swap_back_remove`)
* `Vec::resize`
* `str::slice_mut_unchecked`
* `FileTypeExt`
* `FileTypeExt::{is_block_device, is_char_device, is_fifo, is_socket}`
* `BinaryHeap::from` - `from_vec` deprecated in favor of this
* `BinaryHeap::into_vec` - plus a `Into` impl
* `BinaryHeap::into_sorted_vec`

Deprecated APIs

* `slice::ref_slice`
* `slice::mut_ref_slice`
* `iter::{range_inclusive, RangeInclusive}`
* `std::dynamic_lib`

Closes rust-lang#27706
Closes rust-lang#27725
cc rust-lang#27726 (align not stabilized yet)
Closes rust-lang#27734
Closes rust-lang#27737
Closes rust-lang#27742
Closes rust-lang#27743
Closes rust-lang#27772
Closes rust-lang#27774
Closes rust-lang#27777
Closes rust-lang#27781
cc rust-lang#27788 (a few remaining methods though)
Closes rust-lang#27790
Closes rust-lang#27793
Closes rust-lang#27796
Closes rust-lang#27810
cc rust-lang#28147 (not all parts stabilized)
bors added a commit that referenced this issue Oct 25, 2015
@bors
Auto merge of #29254 - alexcrichton:stabilize-1.5, r=brson
e02ada6 
This commit stabilizes and deprecates library APIs whose FCP has closed in the
last cycle, specifically:

Stabilized APIs:

* `fs::canonicalize`
* `Path::{metadata, symlink_metadata, canonicalize, read_link, read_dir, exists,
   is_file, is_dir}` - all moved to inherent methods from the `PathExt` trait.
* `Formatter::fill`
* `Formatter::width`
* `Formatter::precision`
* `Formatter::sign_plus`
* `Formatter::sign_minus`
* `Formatter::alternate`
* `Formatter::sign_aware_zero_pad`
* `string::ParseError`
* `Utf8Error::valid_up_to`
* `Iterator::{cmp, partial_cmp, eq, ne, lt, le, gt, ge}`
* `<[T]>::split_{first,last}{,_mut}`
* `Condvar::wait_timeout` - note that `wait_timeout_ms` is not yet deprecated
  but will be once 1.5 is released.
* `str::{R,}MatchIndices`
* `str::{r,}match_indices`
* `char::from_u32_unchecked`
* `VecDeque::insert`
* `VecDeque::shrink_to_fit`
* `VecDeque::as_slices`
* `VecDeque::as_mut_slices`
* `VecDeque::swap_remove_front` - (renamed from `swap_front_remove`)
* `VecDeque::swap_remove_back` - (renamed from `swap_back_remove`)
* `Vec::resize`
* `str::slice_mut_unchecked`
* `FileTypeExt`
* `FileTypeExt::{is_block_device, is_char_device, is_fifo, is_socket}`
* `BinaryHeap::from` - `from_vec` deprecated in favor of this
* `BinaryHeap::into_vec` - plus a `Into` impl
* `BinaryHeap::into_sorted_vec`

Deprecated APIs

* `slice::ref_slice`
* `slice::mut_ref_slice`
* `iter::{range_inclusive, RangeInclusive}`
* `std::dynamic_lib`

Closes #27706
Closes #27725
cc #27726 (align not stabilized yet)
Closes #27734
Closes #27737
Closes #27742
Closes #27743
Closes #27772
Closes #27774
Closes #27777
Closes #27781
cc #27788 (a few remaining methods though)
Closes #27790
Closes #27793
Closes #27796
Closes #27810
cc #28147 (not all parts stabilized)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
B-unstable Blocker: Implemented in the nightly compiler and unstable. final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.5
Development

Successfully merging a pull request may close this issue.

std: Stabilize library APIs for 1.5 alexcrichton/rust
5 participants
@steveklabnik @alexcrichton @dhardy @retep998 @aturon