2525/// type cannot conform directly to this protocol (such as a non-final class or
2626/// a type declared in a third-party module), you can create a container type
2727/// that conforms to ``AttachableContainer`` to act as a proxy.
28- @_spi ( Experimental)
28+ ///
29+ /// @Metadata {
30+ /// @Available(Swift, introduced: 6.2)
31+ /// }
2932public protocol Attachable : ~ Copyable {
3033 /// An estimate of the number of bytes of memory needed to store this value as
3134 /// an attachment.
@@ -41,6 +44,10 @@ public protocol Attachable: ~Copyable {
4144 ///
4245 /// - Complexity: O(1) unless `Self` conforms to `Collection`, in which case
4346 /// up to O(_n_) where _n_ is the length of the collection.
47+ ///
48+ /// @Metadata {
49+ /// @Available(Swift, introduced: 6.2)
50+ /// }
4451 var estimatedAttachmentByteCount : Int ? { get }
4552
4653 /// Call a function and pass a buffer representing this instance to it.
@@ -63,7 +70,11 @@ public protocol Attachable: ~Copyable {
6370 /// the buffer to contain an image in PNG format, JPEG format, etc., but it
6471 /// would not be idiomatic for the buffer to contain a textual description of
6572 /// the image.
66- borrowing func withUnsafeBufferPointer< R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R
73+ ///
74+ /// @Metadata {
75+ /// @Available(Swift, introduced: 6.2)
76+ /// }
77+ borrowing func withUnsafeBytes< R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R
6778
6879 /// Generate a preferred name for the given attachment.
6980 ///
@@ -79,6 +90,10 @@ public protocol Attachable: ~Copyable {
7990 /// when adding `attachment` to a test report or persisting it to storage. The
8091 /// default implementation of this function returns `suggestedName` without
8192 /// any changes.
93+ ///
94+ /// @Metadata {
95+ /// @Available(Swift, introduced: 6.2)
96+ /// }
8297 borrowing func preferredName( for attachment: borrowing Attachment < Self > , basedOn suggestedName: String ) -> String
8398}
8499
@@ -99,7 +114,7 @@ extension Attachable where Self: Collection, Element == UInt8 {
99114 count
100115 }
101116
102- // We do not provide an implementation of withUnsafeBufferPointer (for:_:) here
117+ // We do not provide an implementation of withUnsafeBytes (for:_:) here
103118 // because there is no way in the standard library to statically detect if a
104119 // collection can provide contiguous storage (_HasContiguousBytes is not API.)
105120 // If withContiguousStorageIfAvailable(_:) fails, we don't want to make a
@@ -118,40 +133,35 @@ extension Attachable where Self: StringProtocol {
118133
119134// Implement the protocol requirements for byte arrays and buffers so that
120135// developers can attach raw data when needed.
121- @_spi ( Experimental)
122136extension Array < UInt8 > : Attachable {
123- public func withUnsafeBufferPointer < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
137+ public func withUnsafeBytes < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
124138 try withUnsafeBytes ( body)
125139 }
126140}
127141
128- @_spi ( Experimental)
129142extension ContiguousArray < UInt8 > : Attachable {
130- public func withUnsafeBufferPointer < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
143+ public func withUnsafeBytes < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
131144 try withUnsafeBytes ( body)
132145 }
133146}
134147
135- @_spi ( Experimental)
136148extension ArraySlice < UInt8 > : Attachable {
137- public func withUnsafeBufferPointer < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
149+ public func withUnsafeBytes < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
138150 try withUnsafeBytes ( body)
139151 }
140152}
141153
142- @_spi ( Experimental)
143154extension String : Attachable {
144- public func withUnsafeBufferPointer < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
155+ public func withUnsafeBytes < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
145156 var selfCopy = self
146157 return try . withUTF8 { utf8 in
147158 try body ( UnsafeRawBufferPointer ( utf8) )
148159 }
149160 }
150161}
151162
152- @_spi ( Experimental)
153163extension Substring : Attachable {
154- public func withUnsafeBufferPointer < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
164+ public func withUnsafeBytes < R> ( for attachment: borrowing Attachment < Self > , _ body: ( UnsafeRawBufferPointer ) throws -> R ) throws -> R {
155165 var selfCopy = self
156166 return try . withUTF8 { utf8 in
157167 try body ( UnsafeRawBufferPointer ( utf8) )
0 commit comments