Skip to content

[cxx-interop] Document some caveats of safe interop #1094

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
Jul 10, 2025
Merged

[cxx-interop] Document some caveats of safe interop #1094

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
469c9cf
[cxx-interop] Document some caveats of safe interop
Jun 23, 2025
ba955b1
Merge branch 'main' into gaborh/safety-caveats
heckj Jul 10, 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
11 changes: 11 additions & 0 deletions documentation/cxx-interop/safe-interop/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,10 @@ struct SWIFT_NONESCAPABLE StringRef { ... };
Now the Swift compiler imports `StringRef` as a safe type and no longer
emits a warning about using an unsafe type.

<div class="info" markdown="1">
Some containers and protocols do not yet support non-escapable types in Swift 6.2.
</div>

### Annotating C++ APIs

Building the code again will emit a new diagnostic for the `fileName` function about
Expand Down Expand Up @@ -394,6 +398,13 @@ adding additional annotations to C or C++ APIs will not affect Swift code curren
relying on the plain interface. Adding additional information may alter the signature
of any existing safe overload however, since only 1 safe overload per imported function is generated.

<div class="info" markdown="1">
At the time of writing, the features described in this section
are behind an experimental feature flag on the Swift 6.2 release branch.
To enable these features, pass `-enable-experimental-feature SafeInteropWrappers`
to the Swift compiler.
</div>

### Safe Overloads for C++ `std::span`

APIs taking or returning C++'s `std::span` with sufficient lifetime
Expand Down