zerocopy icon indicating copy to clipboard operation
zerocopy copied to clipboard

Add more safety comments to `FromZeros::new_box_zeroed`

Open AlexanderPortland opened this issue 1 month ago • 3 comments

Adds safety comments to two of the undocumented unsafe blocks in FromZeros::new_box_zeroed.

I tried to base their structure off of existing comments and am happy to do modifications if you have feedback!

Is it alright to trust that the std crate's default allocator will return an allocation of the right size and alignment for the given layout? I was looking through documentation to support this, but the std::alloc module says that the default global allocator is unspecified in most cases.

Towards #429

AlexanderPortland avatar Dec 12 '25 00:12 AlexanderPortland

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

google-cla[bot] avatar Dec 12 '25 00:12 google-cla[bot]

Summary of Changes

Hello @AlexanderPortland, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the safety documentation within the FromZeros::new_box_zeroed function. By adding comprehensive SAFETY comments to previously undocumented unsafe blocks, it clarifies the rationale behind these operations and ensures that the code adheres to Rust's safety guidelines, making it easier to understand and maintain.

Highlights

  • Safety Comments Added: Introduced detailed SAFETY comments for two previously undocumented unsafe blocks within the FromZeros::new_box_zeroed function. These comments explain the invariants and justifications for the unsafe operations.
  • Clarity for alloc::alloc::alloc_zeroed: A SAFETY comment was added for the alloc::alloc::alloc_zeroed call, clarifying that the layout's size is guaranteed to be non-zero before allocation, fulfilling its safety requirements.
  • Clarity for Box::from_raw: A SAFETY comment was added for the Box::from_raw call, detailing that the allocation comes from the std crate's default Global allocator, is correctly aligned and non-null, and that T implements FromZeros ensuring a valid zeroed state.
  • Removed clippy Allow Attributes: The #[allow(clippy::undocumented_unsafe_blocks)] attributes have been removed, as the unsafe blocks are now properly documented with SAFETY comments, addressing FIXME(#429).
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

gemini-code-assist[bot] avatar Dec 12 '25 00:12 gemini-code-assist[bot]

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 92.33%. Comparing base (151c20f) to head (8d8bfce).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2847   +/-   ##
=======================================
  Coverage   92.33%   92.33%           
=======================================
  Files          20       20           
  Lines        5794     5794           
=======================================
  Hits         5350     5350           
  Misses        444      444           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov-commenter avatar Dec 12 '25 00:12 codecov-commenter