-
Notifications
You must be signed in to change notification settings - Fork 207
Generalize ContiguousBytes to be noncopyable and nonescapable for spans #1565
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,7 +15,7 @@ | |
| /// Indicates that the conforming type is a contiguous collection of raw bytes | ||
| /// whose underlying storage is directly accessible by withUnsafeBytes. | ||
| @available(macOS 10.10, iOS 8.0, watchOS 2.0, tvOS 9.0, *) | ||
| public protocol ContiguousBytes { | ||
| public protocol ContiguousBytes: ~Escapable, ~Copyable { | ||
| /// Calls the given closure with the contents of underlying storage. | ||
| /// | ||
| /// - note: Calling `withUnsafeBytes` multiple times does not guarantee that | ||
|
|
@@ -109,3 +109,29 @@ extension Slice : ContiguousBytes where Base : ContiguousBytes { | |
| } | ||
| } | ||
| } | ||
|
|
||
| //===--- Span Conformances -----------------------------------------===// | ||
|
|
||
| @available(FoundationPreview 6.3, *) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a public conformance, right? We would need an API review. |
||
| extension RawSpan: ContiguousBytes { | ||
| } | ||
|
|
||
| @available(FoundationPreview 6.3, *) | ||
| extension MutableRawSpan: ContiguousBytes { | ||
| } | ||
|
|
||
| @available(FoundationPreview 6.3, *) | ||
| extension Span: ContiguousBytes where Element == UInt8 { | ||
| } | ||
|
|
||
| @available(FoundationPreview 6.3, *) | ||
| extension MutableSpan: ContiguousBytes where Element == UInt8 { | ||
| } | ||
|
|
||
| @available(FoundationInlineArray 6.3, *) | ||
| extension InlineArray: ContiguousBytes where Element == UInt8 { | ||
| @_alwaysEmitIntoClient | ||
| public func withUnsafeBytes<R, E>(_ body: (UnsafeRawBufferPointer) throws(E) -> R) throws(E) -> R { | ||
| return try span.withUnsafeBytes(body) | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift.org open source project | ||
| // | ||
| // Copyright (c) 2025 Apple Inc. and the Swift project authors | ||
| // Licensed under Apache License v2.0 with Runtime Library Exception | ||
| // | ||
| // See https://swift.org/LICENSE.txt for license information | ||
| // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import Testing | ||
|
|
||
| #if canImport(FoundationEssentials) | ||
| @testable import FoundationEssentials | ||
| #else | ||
| @testable import Foundation | ||
| #endif | ||
|
|
||
| func acceptContiguousBytes<T: ContiguousBytes & ~Escapable & ~Copyable>(_ bytes: borrowing T) { } | ||
|
|
||
| @Suite("ContiguousBytesTests") | ||
| private struct ContiguousBytesTests { | ||
| @Test func span() throws { | ||
| if #available(FoundationPreview 6.3, *) { | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since the function is already annotated as only available on macOS 26+, I don't think we need this |
||
| var bytes: [UInt8] = [1, 2, 3] | ||
| bytes.withUnsafeMutableBufferPointer { unsafeBytes in | ||
| acceptContiguousBytes(unsafeBytes.span) | ||
| acceptContiguousBytes(unsafeBytes.mutableSpan) | ||
| acceptContiguousBytes(unsafeBytes.span.bytes) | ||
|
|
||
| var ms = unsafeBytes.mutableSpan | ||
| acceptContiguousBytes(ms.bytes) | ||
| acceptContiguousBytes(ms.mutableBytes) | ||
| } | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just confirming, are there any ABI implications on this change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, it is not ABI-breaking (or source-breaking) to make this change.