fix: add missing Safety documentation for FFI functions#36
Merged
colemanirby merged 2 commits intoSep 4, 2025
Conversation
Contributor
TrustMeItsCugel
commented
Sep 4, 2025
TrustMeItsCugel
commented
- Add Safety sections to timelock_get_version(), timelock_init(), and timelock_cleanup()
- Resolves clippy missing_safety_doc warnings
- All functions are safe to call from any context despite unsafe extern C marking
- Add Safety sections to timelock_get_version(), timelock_init(), and timelock_cleanup() - Resolves clippy missing_safety_doc warnings - All functions are safe to call from any context despite unsafe extern C marking
- Add brew uninstall cmake before installing to avoid tap conflicts - Resolves CI failure where cmake from local/pinned tap conflicts with homebrew/core - Uses --ignore-dependencies and || true for safe uninstall
Contributor
Author
|
Hi @driemworks, this is ready for review. |
There was a problem hiding this comment.
Pull Request Overview
Adds Safety documentation to FFI functions to resolve clippy warnings about missing safety documentation. The PR clarifies that three timelock FFI functions are safe to call despite their unsafe extern "C" signature.
- Adds Safety sections to
timelock_get_version(),timelock_init(), andtimelock_cleanup()functions - Documents that all functions are safe to call from any context with no special requirements
- Includes a build system fix to uninstall cmake before reinstallation on macOS
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| timelock-ffi/src/lib.rs | Adds Safety documentation sections to three FFI functions |
| .github/workflows/cross-platform-ffi.yml | Adds cmake uninstall step for macOS builds |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
colemanirby
approved these changes
Sep 4, 2025
Contributor
colemanirby
left a comment
colemanirby
left a comment
There was a problem hiding this comment.
LGTM. Thank you for the quick fix and the documentation updates!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.