[RFC][DNM] Add isIdentical Methods for Quick Comparisons to AttributedString and AttributedSubstring

[vanvoorden]

Background

#1383

We propose new isIdentical instance methods to the following concrete types for determining in constant-time if two instances must be equal by-value:

• AttributedString
• AttributedSubstring
• Data

Instead of “one big diff”… we can try and keep the diffs grouped together by similar functionality:

• AttributedString, AttributedSubstring
• Data

Changes

AttributedString

We can look for some clues in the existing == operator on AttributedString.¹ This forwards to methods on Guts.²³⁴ A simpler approach for our diff would be to just check directly over guts without an extra transformation:

extension AttributedString {
  public func isIdentical(to other: Self) -> Bool {
    self._guts === other._guts
  }
}

An orthogonal diff could also choose to check over guts as a fast-path in our == operator.

Because _guts is defined as internal without usableFromInline we do not have an easy way to make isIdentical back deploy with @_alwaysEmitIntoClient. I am open to discussing what our options might be at this point might be to back deploy and what we choose for availability before shipping. It looks like we do have the option to add usableFromInline to our internal variable declarations without breaking ABI.⁵ The tradeoff is we then ship guts as ABI from now on.

AttributedSubstring

We already have a fast path in the existing == operator on AttributedSubstring.⁶ We can implement a similar logic for isIdentical:

extension AttributedSubstring {
  public func isIdentical(to other: Self) -> Bool {
    self._guts === other._guts &&
    self._range == other._range
  }
}

We can have a similar conversation at this point about what our options for back deployment look like.

Test Plan

New tests were added for AttributedString and AttributedSubstring.

Benchmarks

New benchmarks were added for AttributedString and AttributedSubstring.

Footnotes

1. https://github.com/swiftlang/swift-foundation/blob/swift-6.1.2-RELEASE/Sources/FoundationEssentials/AttributedString/AttributedString.swift#L153 ↩

2. https://github.com/swiftlang/swift-foundation/blob/swift-6.1.2-RELEASE/Sources/FoundationEssentials/AttributedString/AttributedString%2BGuts.swift#L77 ↩

3. https://github.com/swiftlang/swift-foundation/blob/swift-6.1.2-RELEASE/Sources/FoundationEssentials/AttributedString/AttributedString%2BGuts.swift#L84-L86 ↩

4. https://github.com/swiftlang/swift-foundation/blob/swift-6.1.2-RELEASE/Sources/FoundationEssentials/AttributedString/AttributedString%2BGuts.swift#L105 ↩

5. https://github.com/swiftlang/swift-evolution/blob/main/proposals/0193-cross-module-inlining-and-specialization.md ↩

6. https://github.com/swiftlang/swift-foundation/blob/swift-6.1.2-RELEASE/Sources/FoundationEssentials/AttributedString/AttributedSubstring.swift#L79-L81 ↩