Address review

CHANGELOG.md

@@ -21,7 +21,7 @@ And please only add new entries to the top of this list, right below the `# Unre
 - Mark `startup_notify` unsafe functions as safe.
 - Fix a bug where Wayland would be chosen on Linux even if the user specified `with_x11`. (#3058)
 - **Breaking:** Moved `ControlFlow` to `EventLoopWindowTarget::set_control_flow()` and `EventLoopWindowTarget::control_flow()`.
-- **Breaking:** Moved `ControlFlow::Exit` to `EventLoopWindowTarget::set_exit()` and `EventLoopWindowTarget::is_exit()` and removed `ControlFlow::ExitWithCode(_)` entirely.
+- **Breaking:** Moved `ControlFlow::Exit` to `EventLoopWindowTarget::set_exit()` and `EventLoopWindowTarget::exiting()` and removed `ControlFlow::ExitWithCode(_)` entirely.
 
 # 0.29.1-beta
 

src/event.rs

@@ -9,7 +9,7 @@
 //! ```rust,ignore
 //! let mut start_cause = StartCause::Init;
 //!
-//! while !elwt.is_exit() {
+//! while !elwt.exiting() {
 //!     event_handler(NewEvents(start_cause), elwt);
 //!
 //!     for e in (window events, user events, device events) {

src/event_loop.rs

@@ -175,7 +175,7 @@ pub enum ControlFlow {
 }
 
 impl ControlFlow {
-    /// Sets this to wait until a timeout has expired.
+    /// Creates a [`ControlFlow`] that waits until a timeout has expired.
     ///
     /// In most cases, this is set to [`WaitUntil`]. However, if the timeout overflows, it is
     /// instead set to [`Wait`].
@@ -320,18 +320,18 @@ impl<T> EventLoopWindowTarget<T> {
         self.p.control_flow()
     }
 
-    /// Send a [`LoopExiting`] event and stop the event loop.
+    /// This exits the event loop.
     ///
-    /// [`LoopExiting`]: Event::LoopExiting
+    /// See [`LoopExiting`](Event::LoopExiting).
     pub fn exit(&self) {
         self.p.exit()
     }
 
     /// Returns if the [`EventLoop`] is about to stop.
     ///
     /// See [`exit()`](Self::exit).
-    pub fn is_exit(&self) -> bool {
-        self.p.is_exit()
+    pub fn exiting(&self) -> bool {
+        self.p.exiting()
     }
 }
 

src/platform_impl/android/mod.rs

@@ -534,10 +534,10 @@ impl<T: 'static> EventLoop<T> {
 
         // Consider the possibility that the `StartCause::Init` iteration could
         // request to Exit
-        if !self.is_exit() {
+        if !self.exiting() {
             self.poll_events_with_timeout(timeout, &mut callback);
         }
-        if self.is_exit() {
+        if self.exiting() {
             self.loop_running = false;
 
             callback(event::Event::LoopExiting, self.window_target());
@@ -645,8 +645,8 @@ impl<T: 'static> EventLoop<T> {
         self.window_target.p.control_flow()
     }
 
-    fn is_exit(&self) -> bool {
-        self.window_target.p.is_exit()
+    fn exiting(&self) -> bool {
+        self.window_target.p.exiting()
     }
 }
 
@@ -712,7 +712,7 @@ impl<T: 'static> EventLoopWindowTarget<T> {
         self.exit.set(true)
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
+    pub(crate) fn exiting(&self) -> bool {
         self.exit.get()
     }
 }

src/platform_impl/ios/event_loop.rs

@@ -70,7 +70,7 @@ impl<T: 'static> EventLoopWindowTarget<T> {
         warn!("`ControlFlow::Exit` ignored on iOS");
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
+    pub(crate) fn exiting(&self) -> bool {
         false
     }
 }

src/platform_impl/linux/mod.rs

@@ -858,8 +858,8 @@ impl<T> EventLoopWindowTarget<T> {
         x11_or_wayland!(match self; Self(evlp) => evlp.exit())
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
-        x11_or_wayland!(match self; Self(evlp) => evlp.is_exit())
+    pub(crate) fn exiting(&self) -> bool {
+        x11_or_wayland!(match self; Self(evlp) => evlp.exiting())
     }
 
     fn set_exit_code(&self, code: i32) {

src/platform_impl/linux/wayland/event_loop/mod.rs

@@ -238,7 +238,7 @@ impl<T: 'static> EventLoop<T> {
 
         // Consider the possibility that the `StartCause::Init` iteration could
         // request to Exit.
-        if !self.is_exit() {
+        if !self.exiting() {
             self.poll_events_with_timeout(timeout, &mut callback);
         }
         if let Some(code) = self.exit_code() {
@@ -619,8 +619,8 @@ impl<T: 'static> EventLoop<T> {
         self.window_target.p.control_flow()
     }
 
-    fn is_exit(&self) -> bool {
-        self.window_target.p.is_exit()
+    fn exiting(&self) -> bool {
+        self.window_target.p.exiting()
     }
 
     fn set_exit_code(&self, code: i32) {

src/platform_impl/linux/wayland/output.rs

@@ -37,7 +37,7 @@ impl<T> EventLoopWindowTarget<T> {
         self.exit.set(Some(0))
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
+    pub(crate) fn exiting(&self) -> bool {
         self.exit.get().is_some()
     }
 

src/platform_impl/linux/x11/mod.rs

@@ -450,7 +450,7 @@ impl<T: 'static> EventLoop<T> {
 
         // Consider the possibility that the `StartCause::Init` iteration could
         // request to Exit.
-        if !self.is_exit() {
+        if !self.exiting() {
             self.poll_events_with_timeout(timeout, &mut callback);
         }
         if let Some(code) = self.exit_code() {
@@ -649,8 +649,8 @@ impl<T: 'static> EventLoop<T> {
         self.target.p.control_flow()
     }
 
-    fn is_exit(&self) -> bool {
-        self.target.p.is_exit()
+    fn exiting(&self) -> bool {
+        self.target.p.exiting()
     }
 
     fn set_exit_code(&self, code: i32) {
@@ -727,7 +727,7 @@ impl<T> EventLoopWindowTarget<T> {
         self.exit.set(Some(0))
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
+    pub(crate) fn exiting(&self) -> bool {
         self.exit.get().is_some()
     }
 

src/platform_impl/macos/app_state.rs

@@ -210,7 +210,7 @@ impl Handler {
         self.exit.store(true, Ordering::Relaxed)
     }
 
-    pub fn is_exit(&self) -> bool {
+    pub fn exiting(&self) -> bool {
         self.exit.load(Ordering::Relaxed)
     }
 
@@ -429,8 +429,8 @@ impl AppState {
         HANDLER.exit()
     }
 
-    pub fn is_exit() -> bool {
-        HANDLER.is_exit()
+    pub fn exiting() -> bool {
+        HANDLER.exiting()
     }
 
     pub fn dispatch_init_events() {
@@ -640,7 +640,7 @@ impl AppState {
         HANDLER.handle_nonuser_event(Event::AboutToWait);
         HANDLER.set_in_callback(false);
 
-        if HANDLER.is_exit() {
+        if HANDLER.exiting() {
             Self::stop();
         }
 

src/platform_impl/macos/event_loop.rs

@@ -106,8 +106,8 @@ impl<T: 'static> EventLoopWindowTarget<T> {
         AppState::exit()
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
-        AppState::is_exit()
+    pub(crate) fn exiting(&self) -> bool {
+        AppState::exiting()
     }
 }
 
@@ -418,7 +418,7 @@ impl<T> EventLoop<T> {
                     resume_unwind(panic);
                 }
 
-                if AppState::is_exit() {
+                if AppState::exiting() {
                     AppState::internal_exit();
                     PumpStatus::Exit(0)
                 } else {

src/platform_impl/orbital/event_loop.rs

@@ -598,7 +598,7 @@ impl<T: 'static> EventLoop<T> {
 
             event_handler(event::Event::AboutToWait, &self.window_target);
 
-            if self.window_target.p.is_exit() {
+            if self.window_target.p.exiting() {
                 break;
             }
 
@@ -752,7 +752,7 @@ impl<T: 'static> EventLoopWindowTarget<T> {
         self.exit.set(true);
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
+    pub(crate) fn exiting(&self) -> bool {
         self.exit.get()
     }
 }

src/platform_impl/web/event_loop/runner.rs

@@ -610,7 +610,7 @@ impl Shared {
             RunnerEnum::Destroyed => return,
         }
 
-        let is_closed = self.is_exit();
+        let is_closed = self.exiting();
 
         // Don't take events out of the queue if the loop is closed or the runner doesn't exist
         // If the runner doesn't exist and this method recurses, it will recurse infinitely
@@ -627,7 +627,7 @@ impl Shared {
     // Apply the new ControlFlow that has been selected by the user
     // Start any necessary timeouts etc
     fn apply_control_flow(&self) {
-        let new_state = if self.is_exit() {
+        let new_state = if self.exiting() {
             State::Exit
         } else {
             match self.control_flow() {
@@ -713,7 +713,7 @@ impl Shared {
     // Check if the event loop is currently closed
     fn is_closed(&self) -> bool {
         match self.0.runner.try_borrow().as_ref().map(Deref::deref) {
-            Ok(RunnerEnum::Running(runner)) => runner.state.is_exit(),
+            Ok(RunnerEnum::Running(runner)) => runner.state.exiting(),
             // The event loop is not closed since it is not initialized.
             Ok(RunnerEnum::Pending) => false,
             // The event loop is closed since it has been destroyed.
@@ -766,7 +766,7 @@ impl Shared {
         self.0.exit.set(true)
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
+    pub(crate) fn exiting(&self) -> bool {
         self.0.exit.get()
     }
 }

src/platform_impl/web/event_loop/state.rs

@@ -20,7 +20,7 @@ pub enum State {
 }
 
 impl State {
-    pub fn is_exit(&self) -> bool {
+    pub fn exiting(&self) -> bool {
         matches!(self, State::Exit)
     }
 }

src/platform_impl/web/event_loop/window_target.rs

@@ -691,7 +691,7 @@ impl<T> EventLoopWindowTarget<T> {
         self.runner.exit()
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
-        self.runner.is_exit()
+    pub(crate) fn exiting(&self) -> bool {
+        self.runner.exiting()
     }
 }

src/platform_impl/windows/event_loop.rs

@@ -554,7 +554,7 @@ impl<T> EventLoopWindowTarget<T> {
         self.runner_shared.set_exit_code(0)
     }
 
-    pub(crate) fn is_exit(&self) -> bool {
+    pub(crate) fn exiting(&self) -> bool {
         self.runner_shared.exit_code().is_some()
     }