Document that Apple handles are main thread only

rust-windowing · Oct 13, 2023 · f963828 · f963828
1 parent 00aa6c4
commit f963828
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/appkit.rs b/src/appkit.rs
@@ -22,6 +22,9 @@ impl AppKitDisplayHandle {
 }
 
 /// Raw window handle for AppKit.
+///
+/// Note that this struct is `!Send` and `!Sync`, so any valid instance of
+/// this must only exist on the main thread.
 #[non_exhaustive]
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 pub struct AppKitWindowHandle {

diff --git a/src/uikit.rs b/src/uikit.rs
@@ -22,6 +22,9 @@ impl UiKitDisplayHandle {
 }
 
 /// Raw window handle for UIKit.
+///
+/// Note that this struct is `!Send` and `!Sync`, so any valid instance of
+/// this must only exist on the main thread.
 #[non_exhaustive]
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 pub struct UiKitWindowHandle {