feat: implement Hash/Eq for host Device types #1068
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add Eq/Hash implementations for Device across ALSA, WASAPI, WebAudio, CoreAudio (macOS/iOS), AudioWorklet, and Null. Hashing is based on backend device identifiers and, for ALSA, PCM ID + direction. WASAPI hashes the COM device ID string obtained via GetId.
There was a problem hiding this comment.
Pull request overview
This PR adds Hash and Eq trait implementations for the Device type across all audio backends (ALSA, WASAPI, WebAudio, CoreAudio for macOS/iOS, AudioWorklet, and Null). This enables Device instances to be used in hash-based collections like HashMap and HashSet.
Key Changes:
- Simple derive macro additions for backends with trivial device types (WebAudio, Null, AudioWorklet, iOS)
- Custom
Hash/Eq/PartialEqimplementations for ALSA based on PCM ID and direction - Custom
Hashimplementation for WASAPI based on COM device ID string - Derive macro addition for CoreAudio macOS which hashes the
AudioDeviceIDfield
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/host/webaudio/mod.rs | Added Hash derive to Device struct for WebAudio backend |
| src/host/wasapi/device.rs | Implemented custom Hash trait using COM device ID string, consistent with existing PartialEq implementation |
| src/host/null/mod.rs | Added Hash derive to Device struct for Null backend |
| src/host/coreaudio/macos/device.rs | Added Hash derive to Device struct, enabling hashing of AudioDeviceID field |
| src/host/coreaudio/ios/mod.rs | Added Hash derive to Device struct for iOS CoreAudio backend |
| src/host/audioworklet/mod.rs | Added Hash derive to Device struct for AudioWorklet backend |
| src/host/alsa/mod.rs | Implemented custom Hash, PartialEq, and Eq traits based on PCM ID and direction fields |
| CHANGELOG.md | Documented the new Hash/Eq implementations and updated wording for consistency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
alsa::Direction doesn't implement Hash, so map Capture/Playback/None to distinct u8 values when hashing the Device to keep Hash consistent with PartialEq.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
EqandHashimplementations forDeviceacross ALSA, WASAPI, WebAudio, CoreAudio (macOS/iOS), AudioWorklet, and Null. Hashing is based on backend device identifiers and, for ALSA, PCM ID + direction. WASAPI hashes the COM device ID string obtained viaGetId.