ndk: Implement common traits where sensible, and drop some Ord

Provided traits in the `ndk` crate are all over the place. Some pointer wrappers and regular enumerations derive `(Partial)Ord` even though there is no sense in using an ordering for these types. Others don't derive `(Partial)Eq` and `Hash` which makes it hard to compare if objects are the same (by-pointer) or to store them inside i.e. `HashMap`. Deriving these types follows Rust's [C-COMMON-TRAITS] convention. Additionally, sort `derives` by their relation, followed by sorting them alphabetically. [C-COMMON-TRAITS]: https://rust-lang.github.io/api-guidelines/interoperability.html#types-eagerly-implement-common-traits-c-common-traits
rust-mobile · Aug 10, 2024 · 1e95ff3 · 1e95ff3
1 parent e4a0b94
commit 1e95ff3
Show file tree

Hide file tree

Showing 19 changed files with 107 additions and 104 deletions.
diff --git a/ndk/src/asset.rs b/ndk/src/asset.rs
@@ -14,7 +14,7 @@ use std::{
 /// A native [`AAssetManager *`]
 ///
 /// [`AAssetManager *`]: https://developer.android.com/ndk/reference/group/asset#aassetmanager
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Eq, Hash)]
 #[doc(alias = "AAssetManager")]
 pub struct AssetManager {
     ptr: NonNull<ffi::AAssetManager>,
@@ -92,7 +92,7 @@ impl AssetManager {
 /// ```
 ///
 /// [`AAssetDir *`]: https://developer.android.com/ndk/reference/group/asset#aassetdir
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Eq, Hash)]
 #[doc(alias = "AAssetDir")]
 pub struct AssetDir {
     ptr: NonNull<ffi::AAssetDir>,
@@ -175,7 +175,7 @@ impl Iterator for AssetDir {
 /// ```
 ///
 /// [`AAsset *`]: https://developer.android.com/ndk/reference/group/asset#aasset
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Eq, Hash)]
 #[doc(alias = "AAsset")]
 pub struct Asset {
     ptr: NonNull<ffi::AAsset>,

diff --git a/ndk/src/audio.rs b/ndk/src/audio.rs
@@ -29,7 +29,7 @@ use crate::utils::abort_on_panic;
 /// [`android.media.AudioAttributes`]: https://developer.android.com/reference/android/media/AudioAttributes
 #[cfg(feature = "api-level-29")]
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "aaudio_allowed_capture_policy_t")]
 #[non_exhaustive]
 pub enum AudioAllowedCapturePolicy {
@@ -83,7 +83,7 @@ pub enum AudioAllowedCapturePolicy {
 /// [`android.media.AudioAttributes`]: https://developer.android.com/reference/android/media/AudioAttributes
 #[cfg(feature = "api-level-28")]
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "aaudio_content_type_t")]
 #[non_exhaustive]
 pub enum AudioContentType {
@@ -107,7 +107,7 @@ pub enum AudioContentType {
 }
 
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "aaudio_direction_t")]
 #[non_exhaustive]
 pub enum AudioDirection {
@@ -124,7 +124,7 @@ pub enum AudioDirection {
 }
 
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[allow(non_camel_case_types)]
 #[doc(alias = "aaudio_format_t")]
 #[non_exhaustive]
@@ -159,7 +159,7 @@ pub enum AudioFormat {
 /// Note that these match the equivalent values in MediaRecorder.AudioSource in the Android Java API.
 #[cfg(feature = "api-level-28")]
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "aaudio_input_preset_t")]
 #[non_exhaustive]
 pub enum AudioInputPreset {
@@ -193,7 +193,7 @@ pub enum AudioInputPreset {
 }
 
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "aaudio_performance_mode_t")]
 #[non_exhaustive]
 pub enum AudioPerformanceMode {
@@ -216,7 +216,7 @@ pub enum AudioPerformanceMode {
 }
 
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "aaudio_sharing_mode_t")]
 #[non_exhaustive]
 pub enum AudioSharingMode {
@@ -245,7 +245,7 @@ pub enum AudioSharingMode {
 /// [`android.media.AudioAttributes`]: https://developer.android.com/reference/android/media/AudioAttributes
 #[cfg(feature = "api-level-28")]
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "aaudio_usage_t")]
 #[non_exhaustive]
 pub enum AudioUsage {
@@ -312,7 +312,7 @@ pub enum AudioUsage {
 }
 
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "aaudio_stream_state_t")]
 #[non_exhaustive]
 pub enum AudioStreamState {
@@ -358,21 +358,21 @@ impl AudioStreamState {
     }
 }
 
-#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 #[doc(alias = "aaudio_session_id_t")]
 pub enum SessionId {
     None,
     Allocated(NonZeroI32),
 }
 
-#[derive(Copy, Clone, Debug)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 pub struct Timestamp {
     pub frame_position: i64,
     pub time_nanoseconds: i64,
 }
 
 #[repr(u32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 #[non_exhaustive]
 pub enum Clockid {
     #[doc(alias = "CLOCK_MONOTONIC")]
@@ -383,7 +383,7 @@ pub enum Clockid {
 
 /// Value returned the data callback function.
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, IntoPrimitive)]
 #[doc(alias = "aaudio_data_callback_result_t")]
 #[non_exhaustive]
 pub enum AudioCallbackResult {
@@ -399,7 +399,7 @@ pub enum AudioCallbackResult {
 }
 
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "aaudio_result_t")]
 #[non_exhaustive]
 pub enum AudioError {
@@ -983,6 +983,7 @@ impl Drop for AudioStreamBuilder {
 ///
 /// [`AAudioStream *`]: https://developer.android.com/ndk/reference/group/audio#aaudiostream
 #[doc(alias = "AAudioStream")]
+// #[derive(Debug, PartialEq, Eq, Hash)]
 pub struct AudioStream {
     inner: NonNull<ffi::AAudioStream>,
     data_callback: Option<AudioStreamDataCallback>,

diff --git a/ndk/src/bitmap.rs b/ndk/src/bitmap.rs
@@ -16,7 +16,7 @@ use crate::data_space::DataSpace;
 use crate::hardware_buffer::HardwareBufferRef;
 
 #[repr(i32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[non_exhaustive]
 pub enum BitmapError {
     #[doc(alias = "ANDROID_BITMAP_RESULT_ALLOCATION_FAILED")]
@@ -90,7 +90,7 @@ pub enum BitmapFormat {
 /// An immediate wrapper over [`android.graphics.Bitmap`]
 ///
 /// [`android.graphics.Bitmap`]: https://developer.android.com/reference/android/graphics/Bitmap
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Eq, Hash)]
 pub struct Bitmap {
     env: *mut JNIEnv,
     inner: jobject,
@@ -299,7 +299,7 @@ impl Bitmap {
 /// Possible values for [`ffi::ANDROID_BITMAP_FLAGS_ALPHA_MASK`] within [`BitmapInfoFlags`]
 #[repr(u32)]
 #[cfg(feature = "api-level-30")]
-#[derive(Clone, Copy, Debug, IntoPrimitive, FromPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "ANDROID_BITMAP_FLAGS_ALPHA_MASK")]
 #[non_exhaustive]
 pub enum BitmapInfoFlagsAlpha {
@@ -321,7 +321,7 @@ pub enum BitmapInfoFlagsAlpha {
 /// Bitfield containing information about the bitmap.
 #[cfg(feature = "api-level-30")]
 #[repr(transparent)]
-#[derive(Clone, Copy, Hash, PartialEq, Eq)]
+#[derive(Clone, Copy, PartialEq, Eq, Hash)]
 pub struct BitmapInfoFlags(u32);
 
 #[cfg(feature = "api-level-30")]
@@ -359,7 +359,7 @@ impl BitmapInfoFlags {
 /// A native [`AndroidBitmapInfo`]
 ///
 /// [`AndroidBitmapInfo`]: https://developer.android.com/ndk/reference/struct/android-bitmap-info#struct_android_bitmap_info
-#[derive(Clone, Copy)]
+#[derive(Clone, Copy)] // TODO: PartialEq, Eq, Hash
 #[doc(alias = "AndroidBitmapInfo")]
 pub struct BitmapInfo {
     inner: ffi::AndroidBitmapInfo,
@@ -440,7 +440,7 @@ impl BitmapInfo {
 /// [`Bitmap::compress_raw()`].
 #[cfg(feature = "api-level-30")]
 #[repr(i32)]
-#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[doc(alias = "AndroidBitmapCompressFormat")]
 #[non_exhaustive]
 pub enum BitmapCompressFormat {
@@ -477,7 +477,7 @@ pub enum BitmapCompressFormat {
 
 /// Encapsulates possible errors returned by [`Bitmap::compress()`] or [`Bitmap::compress_raw()`].
 #[cfg(feature = "api-level-30")]
-#[derive(Debug, thiserror::Error)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, thiserror::Error)]
 pub enum BitmapCompressError {
     #[error(transparent)]
     BitmapError(#[from] BitmapError),

diff --git a/ndk/src/configuration.rs b/ndk/src/configuration.rs
@@ -19,6 +19,7 @@ use std::ptr::NonNull;
 /// [`Configuration`] is an opaque type used to get and set various subsystem configurations.
 ///
 /// [`AConfiguration *`]: https://developer.android.com/ndk/reference/group/configuration#aconfiguration
+// TODO: Implement hash based on ptr or contents?
 pub struct Configuration {
     ptr: NonNull<ffi::AConfiguration>,
 }
@@ -280,7 +281,7 @@ impl Configuration {
 }
 
 /// A bitfield representing the differences between two [`Configuration`]s
-#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 pub struct DiffResult(pub u32);
 
 impl DiffResult {
@@ -337,7 +338,7 @@ impl DiffResult {
     }
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum Orientation {
@@ -351,7 +352,7 @@ pub enum Orientation {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum Touchscreen {
@@ -365,7 +366,7 @@ pub enum Touchscreen {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)] // TODO: Ord?
 #[repr(i32)]
 #[non_exhaustive]
 pub enum Density {
@@ -432,7 +433,7 @@ impl Density {
     }
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum Keyboard {
@@ -446,7 +447,7 @@ pub enum Keyboard {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum Navigation {
@@ -461,7 +462,7 @@ pub enum Navigation {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum KeysHidden {
@@ -475,7 +476,7 @@ pub enum KeysHidden {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum NavHidden {
@@ -488,7 +489,7 @@ pub enum NavHidden {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)] // TODO: Ord?
 #[repr(i32)]
 #[non_exhaustive]
 pub enum ScreenSize {
@@ -503,7 +504,7 @@ pub enum ScreenSize {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum ScreenLong {
@@ -516,7 +517,7 @@ pub enum ScreenLong {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum ScreenRound {
@@ -529,7 +530,7 @@ pub enum ScreenRound {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum WideColorGamut {
@@ -542,7 +543,7 @@ pub enum WideColorGamut {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum HDR {
@@ -555,7 +556,7 @@ pub enum HDR {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum LayoutDir {
@@ -568,7 +569,7 @@ pub enum LayoutDir {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum UiModeType {
@@ -586,7 +587,7 @@ pub enum UiModeType {
     __Unknown(i32),
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, FromPrimitive, IntoPrimitive)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, FromPrimitive, IntoPrimitive)]
 #[repr(i32)]
 #[non_exhaustive]
 pub enum UiModeNight {