Skip to content

Commit

Permalink
Document Window Drop behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
daxpedda committed Dec 24, 2023
1 parent 775c8ec commit b30a399
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/window.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ pub use cursor_icon::{CursorIcon, ParseError as CursorIconParseError};

/// Represents a window.
///
/// To close the [`Window`] it can be dropped.
///
/// # Threading
///
Expand All @@ -28,7 +29,6 @@ pub use cursor_icon::{CursorIcon, ParseError as CursorIconParseError};
/// window from a thread other than the main, the code is scheduled to run on
/// the main thread, and your thread may be blocked until that completes.
///
///
/// # Example
///
/// ```no_run
Expand All @@ -52,6 +52,11 @@ pub use cursor_icon::{CursorIcon, ParseError as CursorIconParseError};
/// }
/// });
/// ```
///
/// ## Platform-specific
///
/// **Web:** The [`Window`], which is represented by a `HTMLElementCanvas`, can
/// not be closed by dropping the [`Window`].
pub struct Window {
pub(crate) window: platform_impl::Window,
}
Expand All @@ -62,6 +67,9 @@ impl fmt::Debug for Window {
}
}

/// This will close the [`Window`].
///
/// See [`Window`] for more details.
impl Drop for Window {
fn drop(&mut self) {
self.window.maybe_wait_on_main(|w| {
Expand Down

0 comments on commit b30a399

Please sign in to comment.