Skip to content

Emphasize borrowing rule in C docs #1422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 17, 2025
Merged

Emphasize borrowing rule in C docs #1422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4327f1e
Emphasize borrowing rule in C docs
MendyBerger Nov 17, 2025
86c64c1
Use a pinned nightly
alexcrichton Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,11 @@ jobs:
- run: cargo test -p wit-bindgen --all-features
- run: cargo test -p wit-bindgen-rust
- run: cargo test --workspace --exclude 'wit-bindgen*'
- run: rustup update nightly --no-self-update
- run: rustup component add miri --toolchain nightly
- run: rustup component add rust-src --toolchain nightly
- run: cargo +nightly miri test -p wit-bindgen --all-features
- run: rustup update nightly-2025-11-10 --no-self-update
- run: rustup default nightly-2025-11-10
- run: rustup component add miri
- run: rustup component add rust-src
- run: cargo miri test -p wit-bindgen --all-features

check:
name: Check
Expand Down
2 changes: 1 addition & 1 deletion crates/c/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ The importing component's responsibility for dropping borrows of imported resour
- If the borrow was passed as an argument to one of the importing component's exports:
- If the bindings were generated with `--autodrop-borrows=yes`, then borrowed handles will be automatically dropped when the exported function returns; no additional action is required by importing component
- If the bindings were generated with `--autodrop-borrow=no`, or this command line option was not supplied, then the importing component must drop the borrowed handle by calling the generated `*_drop_borrow` function.
- If the component obtained the borrow by calling `*_borrow*_` on an owned resource, it must not call `*_drop_borrow`
- If the component obtained the borrow by calling `*_borrow*_` on an owned resource, it must **not** call `*_drop_borrow`

Here is a potential implementation of the `run` export that correctly handles the lifetime of the owned cat resource retrieved from `get-cat-by-name`:

Expand Down
Loading