Skip to content

Document semantics of add_entry parameter to readdir callback. #199

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document semantics of add_entry parameter to readdir callback. #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/api/filesystem/async_io.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,9 @@ pub trait AsyncFileSystem: FileSystem {
/// the file system did not return a `Handle` from `opendir` then the contents of `handle` are
/// undefined.
///
/// `size` indicates the maximum number of bytes that should be returned by this method.
/// `size` indicates the maximum number of bytes that should be returned by this method,
/// but can be ignored in practice. Instead, entries are returned by calling the
/// `add_entry` function until it returns zero (indicating that the buffer is full).
///
/// If `offset` is non-zero then it corresponds to one of the `offset` values from a `DirEntry`
/// that was previously returned by a call to `readdir` for the same handle. In this case the
Expand Down Expand Up @@ -659,7 +661,9 @@ pub trait AsyncFileSystem: FileSystem {
/// the file system did not return a `Handle` from `opendir` then the contents of `handle` are
/// undefined.
///
/// `size` indicates the maximum number of bytes that should be returned by this method.
/// `size` indicates the maximum number of bytes that should be returned by this method,
/// but can be ignored in practice. Instead, entries are returned by calling the
/// `add_entry` function until it returns zero (indicating that the buffer is full).
///
/// Unlike `readdir`, the lookup count for `Inode`s associated with the returned directory
/// entries **IS** affected by this method (since it returns an `Entry` for each `DirEntry`).
Expand Down
9 changes: 7 additions & 2 deletions src/api/filesystem/sync_io.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,9 @@ pub trait FileSystem {
/// the file system did not return a `Handle` from `opendir` then the contents of `handle` are
/// undefined.
///
/// `size` indicates the maximum number of bytes that should be returned by this method.
/// `size` indicates the maximum number of bytes that should be returned by this method,
/// but can be ignored in practice. Instead, entries are returned by calling the
/// `add_entry` function until it returns zero (indicating that the buffer is full).
///
/// If `offset` is non-zero then it corresponds to one of the `offset` values from a `DirEntry`
/// that was previously returned by a call to `readdir` for the same handle. In this case the
Expand Down Expand Up @@ -675,7 +677,10 @@ pub trait FileSystem {
/// the file system did not return a `Handle` from `opendir` then the contents of `handle` are
/// undefined.
///
/// `size` indicates the maximum number of bytes that should be returned by this method.
/// `size` indicates the maximum number of bytes that should be returned by this method,
/// but can be ignored in practice. Instead, entries are returned by calling the
/// `add_entry` function until it returns zero (indicating that the buffer is full).
///
///
/// Unlike `readdir`, the lookup count for `Inode`s associated with the returned directory
/// entries **IS** affected by this method (since it returns an `Entry` for each `DirEntry`).
Expand Down
Loading