Allow to call bang func only to make return

[jackalcooper]

Summary by CodeRabbit

• New Features

  • Enhanced function return handling with a new wrap_ret_call method
  • Improved parameter flexibility for function attribute definitions

• Refactor

  • Streamlined return value management in the NIFFunc function
  • Modified function signature to support compile-time attribute parameters

[coderabbitai]

Walkthrough

The pull request introduces modifications to the src/kinda.zig file, focusing on enhancing the function return handling mechanism. A new method wrap_ret_call is added to the BangFunc structure, which provides a more structured approach to managing function return values and their associated resources. Simultaneously, the NIFFunc function signature is updated to use a compile-time parameter for attributes, offering increased flexibility in attribute definition.

Changes

File	Change Summary
src/kinda.zig	- Added wrap_ret_call method to BangFunc for structured return value handling - Modified NIFFunc function signature to use compile-time attrs parameter

Sequence Diagram

sequenceDiagram
    participant NIFFunc as NIFFunc
    participant BangFunc as BangFunc
    participant wrap_ret_call as wrap_ret_call

    NIFFunc->>BangFunc: Invoke function
    BangFunc->>wrap_ret_call: Call with environment and arguments
    wrap_ret_call-->>BangFunc: Return tuple with return type and resource
    BangFunc-->>NIFFunc: Return processed result

Loading

Possibly related PRs

• Expose BangFunc #37: Modifies NIFFunc function signature and involves BangFunc structure, directly related to the new wrap_ret_call function

Poem

🐰 In Zig's realm of function might,
A wrapper dance of return's delight!
Compile-time attrs now take flight,
Resources wrapped with clever sight,
Code flows smooth as rabbit's might! 🚀

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/kinda.zig (1)

294-304: Consider caching repeated atoms and verifying error handling.

The usage of beam.make_atom(env, "kind") and the newly introduced beam.make_atom(env, RetKind.module_name) in each call may introduce overhead if this function is called frequently. For performance, you might consider caching these atoms in a static variable or storing them at module initialization. Additionally, ensure that all failure modes (allocation, resource creation, etc.) are properly tested to confirm comprehensive error handling coverage.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7c90de1 and 7bf0dcd.

📒 Files selected for processing (1)

• src/kinda.zig (2 hunks)

🔇 Additional comments (2)

src/kinda.zig (2)

316-316: Ensure consistent return handling for void functions.

This line delegates the return handling to wrap_ret_call, which works well for non-void return types. However, if there's any plan to expand the 'void return' scenario in the future (e.g., partial returns or logs), ensure that the wrap_ret_call usage remains consistent or is clearly gated by logic to handle these scenarios.

---

322-322: Verify and update all call sites to the new compile-time attribute signature.

The signature change to comptime attrs: NIFFuncAttrs can break upstream calls or macros that pass mutable data as attrs. Review or test any existing calls to ensure they remain functional and update them if necessary.