-
-
Notifications
You must be signed in to change notification settings - Fork 738
Handle DirEntry
as a first-class citizen parameter of file- and path-related functions
#10754
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.
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
Draft
0xEAB
wants to merge
60
commits into
dlang:master
Choose a base branch
from
0xEAB:DirEntry-ng/windows
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This documents a previously undocumented function.
Reviewer beware! |
DirEntry
as a first-class citizen parameter with file- and path-related functionsDirEntry
as a first-class citizen parameter of file- and path-related functions
This reverts commit 7484666.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I’m opening this as a proof-of-concept PR for my own peace of mind.
Currently, a good chunk of file- and path-related functions accepts
DirEntry
structures as parameter through implicit conversion tostring
provided by thealias name this
property ofDirEntry
. This unfortunately comes with the downside that it pins relative paths to the current working directory at the time of the function call. While this is fine in theory, in practice the current working directory might no longer be the one that the string stored in aDirEntry
structure is relative to. Though obviously a bug in user code, it also poses an unnecessary footgun — as outlined in #9584.This could be one of the better ways to solve the underlying issue. I’ve attempted to keep things as backwards-compatible as possible.
The current implementation focuses on Windows where absolute paths are not applicable to restrictions imposed by filesystem permissions of parent directories. A POSIX implementation would likely be more complex and have to involve the usage of more specific system APIs that work on handles instead of path strings and such.
Speaking of #9584, we obviously cannot fix the risks imposed by code that explicitly converts
DirEntry
tostring
without greater breakage.As @jmdavis has already hinted, though, there’s a change we might prefer to call it a day for Phobos v2 and provide an overall better API in Phobos v3.