search

magicant / yash-rs

Reimplementation of yash, an extended POSIX shell
64 stars 3 forks source link

Replace FileStat with Stat #395

Closed magicant closed 1 month ago

magicant commented 1 month ago

This is part of #353. The FileStat and SFlag are removed in favor of the new Stat type.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates to the yash-env project significantly enhance the system module by introducing new types and methods that improve file handling and metadata representation. Key changes include the introduction of FileType and Stat, updates to existing methods for better clarity, and a shift away from older types like FileStat. These enhancements streamline interactions with system-level operations, promoting ease of use and maintaining a cohesive interface.

Changes

Files Change Summary
yash-env/src/system.rs Expanded System trait with new methods; updated return types from FileStat to Stat; added intuitive constants for Mode.
yash-env/src/pwd.rs Removed same_files function, now utilizing identity() method for file comparison.
yash-env/src/system/file_system.rs Introduced FileType enum and Stat struct for clearer file type handling and improved metadata structure.
yash-env/src/system/real.rs Updated fstat and fstatat methods to return Stat, with changes to enhance safety using MaybeUninit.
yash-env/src/system/shared.rs Modified fstat and fstatat methods to return Stat, ensuring consistency across system implementations.
yash-env/src/system/virtual.rs Removed stat function; methods now return Stat directly, simplifying metadata retrieval.
yash-env/src/system/virtual/file_system.rs Added stat method to INode and type/size methods to FileBody for better metadata access.
yash-semantics/src/redir.rs Simplified file type checks in open_file_noclobber, replacing bitwise operations with FileType checks for improved readability.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant FileType
    participant Stat

    User->>System: Request file status
    System->>FileType: Determine file type
    FileType-->>System: Return file type
    System->>Stat: Retrieve file metadata
    Stat-->>System: Return file metadata
    System-->>User: Provide file status

🐇 In a world of files, both big and small,
The changes we bring will help one and all.
With types that are clear and methods that shine,
Every rabbit coder will save precious time!
Happy coding, my friends, let’s hop with delight,
As we build up our tools to new heights! 🐾✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.