Skip to content

Conversation

czechboy0
Copy link
Contributor

Motivation

Fixes #14 - the naming was a bit inconsistent, as it's not decoding "hex bytes" from a "string", but instead "bytes" from a "hex string".

Modifications

Renamed types:

  • Base64ByteFromStringDecoder -> ConfigBytesFromBase64StringDecoder
  • HexByteFromStringDecoder -> ConfigBytesFromHexStringDecoder

Result

Better names.

Test Plan

Updated tests.

@czechboy0 czechboy0 requested a review from FranzBusch October 13, 2025 13:51
@czechboy0 czechboy0 added the ⚠️ semver/major Breaks existing public API. label Oct 13, 2025
@czechboy0
Copy link
Contributor Author

Indeed, we're knowingly breaking API here pre-1.0:

8 breaking changes detected in Configuration:
  💔 API breakage: var ConfigBytesFromStringDecoder.base64 has declared type change from Configuration.Base64BytesFromStringDecoder to Configuration.ConfigBytesFromBase64StringDecoder
  💔 API breakage: accessor ConfigBytesFromStringDecoder.base64.Get() has generic signature change from <Self where Self == Configuration.Base64BytesFromStringDecoder> to <Self where Self == Configuration.ConfigBytesFromBase64StringDecoder>
  💔 API breakage: accessor ConfigBytesFromStringDecoder.base64.Get() has return type change from Configuration.Base64BytesFromStringDecoder to Configuration.ConfigBytesFromBase64StringDecoder
  💔 API breakage: var ConfigBytesFromStringDecoder.hex has declared type change from Configuration.HexByteFromStringDecoder to Configuration.ConfigBytesFromHexStringDecoder
  💔 API breakage: accessor ConfigBytesFromStringDecoder.hex.Get() has generic signature change from <Self where Self == Configuration.HexByteFromStringDecoder> to <Self where Self == Configuration.ConfigBytesFromHexStringDecoder>
  💔 API breakage: accessor ConfigBytesFromStringDecoder.hex.Get() has return type change from Configuration.HexByteFromStringDecoder to Configuration.ConfigBytesFromHexStringDecoder
  💔 API breakage: struct Base64BytesFromStringDecoder has been removed
  💔 API breakage: struct HexByteFromStringDecoder has been removed

@czechboy0 czechboy0 merged commit 5932a13 into apple:main Oct 14, 2025
31 of 32 checks passed
@czechboy0 czechboy0 deleted the hd-rename-bytes-from-string-decoders branch October 14, 2025 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

⚠️ semver/major Breaks existing public API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename HexByteFromStringDecoder to BytesFromHexStringDecoder?

2 participants