Format, fix, document, Etc 08/15 #402
Open
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 was referenced Sep 16, 2025
rarensu
force-pushed
the
format-fix-document-etc-08/15
branch
3 times, most recently
from
82fbc28 to
7ac26a8
Compare
Satisfied clippy with `#[allow(unused_variables)]`. The default implementations may or may not use the variables, but that is not relevant to a reader who wants to understand the API; for that purpose, the underscores are merely a distraction.
rarensu
force-pushed
the
format-fix-document-etc-08/15
branch
from
7ac26a8 to
b0552f7
Compare
cberner
requested changes
Oct 18, 2025
| ### Feature Gates | ||
|
|
||
| The crate uses feature gates to manage optional functionality and dependencies. Some key features include: | ||
| * **`abi-7-x`**: A set of features to select the FUSE protocol version. Recommended to select the highest version. |
Owner
There was a problem hiding this comment.
We should recommend selecting the lowest version that provides the features the user needs. Not the highest. Selecting the highest will limit compatibility
| A brief overview of Fuser concepts for new contributors. | ||
|
|
||
| * **`Session`**: The core struct which saves configuration options. Its provides methods to start and end event handling loops. | ||
| * **`Request`** and **`Reply`**: These structures represents one FUSE operation initiated by the Kernel. The Request methods handle unpacks this message, and directs it to the filesystem. The Reply methods packege the response and pass it back to the kernel. |
Owner
There was a problem hiding this comment.
typo: "packege[sic]" should be "package"
|
|
||
| ### Subdirectories | ||
|
|
||
| A bried overview of repository organization for new contributors. |
| A bried overview of repository organization for new contributors. | ||
|
|
||
| * **`src/mnt/`**: Code for establishing communication with the fuse device, which is called mounting. | ||
| * **`src/ll/`**: The low-level FUSE message interface. This module contains the raw FUSE ABI definitions and is responsible for the translating between Rust-based data structures and byte-based fuse kernel messages. It is not recommended for applications to use this code directly. |
Owner
There was a problem hiding this comment.
It is not recommended for applications to use this code directly. remove this part. It's not possible for an application to use it, since it is private
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Some additional documentation.
Removed the annoying underscores from
Filesystemmethod signatures.Previous PR in sequence was #401
Next PR in sequence was #404