add default wrapper implementations #1
Conversation
There was a problem hiding this comment.
I’m very sorry for having missed this PR!
In general it makes sense to me, would be a good addition. The Cargo.lock file so far was completely inconsequential, but when adding dependencies I agree that it should be removed from git.
Regarding those dependencies: now that SyncWrapper is no_std, this PR would need to add a std feature that forwards to futures-core/std.
src/lib.rs
Outdated
| @@ -19,6 +19,8 @@ | |||
| #![doc(html_logo_url = "https://developer.actyx.com/img/logo.svg")] | |||
| #![doc(html_favicon_url = "https://developer.actyx.com/img/favicon.ico")] | |||
|
|
|||
| pub mod ext; | |||
There was a problem hiding this comment.
I’d probably put everything into lib.rs — the library is still pretty small.
src/ext.rs
Outdated
| use std::future::Future; | ||
| use std::task::{Context, Poll}; | ||
| use std::pin::Pin; | ||
|
|
There was a problem hiding this comment.
Could you add doc comments with examples?
src/ext.rs
Outdated
| impl <F> SyncFuture<F> { | ||
| pub fn new(fut: F) -> Self { | ||
| Self { fut: SyncWrapper::new(fut) } | ||
| } |
akiradeveloper
force-pushed
the
default-impl
branch
from
44e3b53
to
d1c7aec
Compare
Cargo.toml
Outdated
| futures = { version = "0.3" } | ||
|
|
||
| [dependencies] | ||
| futures-core = { version = "0.3" } |
There was a problem hiding this comment.
how about
| futures-core = { version = "0.3" } | |
| futures-core = { version = "0.3", default-features = false } |
to keep this crate no_std?
src/lib.rs
Outdated
| Self { inner: SyncWrapper::new(inner) } | ||
| } | ||
| pub fn into_inner(self) -> SyncWrapper<F> { | ||
| self.inner |
There was a problem hiding this comment.
Since SyncWrapper is an implementation detail of SyncFuture, I’d want to return plain F from this function.
src/lib.rs
Outdated
| /// | ||
| /// let fut = async { 1 }; | ||
| /// let fut = SyncFuture::new(fut); | ||
| /// ``` |
There was a problem hiding this comment.
I usually put these docs on the struct itself, which has the added benefit of showing the first line in the summary of the docs.
akiradeveloper
force-pushed
the
default-impl
branch
from
90ebc86
to
61f0f2d
Compare
akiradeveloper
force-pushed
the
default-impl
branch
from
61f0f2d
to
c79ab8f
Compare
This PR adds default wrapper implementations for
FutureandStream.This crate is typically used to add
Syncto these two traits so it is good to have default implementations.Also, as this is a library crate let's untrack Cargo.lock file.