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.

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

AbstractFilesystem: Add doc comments #40

Merged
merged 2 commits into from
Jun 18, 2024

Conversation

Turbo87
Copy link
Collaborator

@Turbo87 Turbo87 commented Jun 18, 2024

The std::io::ErrorKind::NotFound behavior wasn't properly described previously, so this PR adds a couple of doc comments to the trait and impl.

@LukeMathWalker LukeMathWalker merged commit 93418b1 into LukeMathWalker:master Jun 18, 2024
4 checks passed
Comment on lines +13 to +14
/// This method should return a [std::io::ErrorKind::NotFound] error if the
/// directory does not exist.
Copy link
Collaborator Author

@Turbo87 Turbo87 Jun 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just discovered that the read_dir() call in the Filesystem impl also likes to return std::io::ErrorKind::NotADirectory in some cases. Unfortunately, that variant has been unstable for the past 3ish years so we can't actually produce it ourselves and neither can we match against it... 😩

Related:

@Turbo87 Turbo87 added the enhancement New feature or request label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants