Update async-std, stop-token, migrate to stable channels

Author: seijikun

Cargo.toml

@@ -27,11 +27,11 @@ nom = "5.0"
 base64 = "0.13"
 chrono = "0.4"
 async-native-tls = { version = "0.3.3" }
-async-std = { version = "1.6.0", default-features = false, features = ["std"] }
+async-std = { version = "1.8.0", default-features = false, features = ["std"] }
 pin-utils = "0.1.0-alpha.4"
 futures = "0.3.0"
 rental = "0.5.5"
-stop-token = { version = "0.1.1", features = ["unstable"] }
+stop-token = "0.2"
 byte-pool = "0.2.2"
 lazy_static = "1.4.0"
 log = "0.4.8"
@@ -41,7 +41,7 @@ thiserror = "1.0.9"
 lettre_email = "0.9"
 pretty_assertions = "0.6.1"
 async-smtp = { version = "0.3.0" }
-async-std = { version = "1.6.0", default-features = false, features = ["std", "attributes"] }
+async-std = { version = "1.8.0", default-features = false, features = ["std", "attributes"] }
 
 [[example]]
 name = "basic"

src/client.rs

@@ -5,10 +5,10 @@ use std::pin::Pin;
 use std::str;
 
 use async_native_tls::{TlsConnector, TlsStream};
+use async_std::channel;
 use async_std::io::{self, Read, Write};
 use async_std::net::{TcpStream, ToSocketAddrs};
 use async_std::prelude::*;
-use async_std::sync;
 use imap_proto::{RequestId, Response};
 
 use super::authenticator::Authenticator;
@@ -36,11 +36,11 @@ macro_rules! quote {
 #[derive(Debug)]
 pub struct Session<T: Read + Write + Unpin + fmt::Debug> {
     pub(crate) conn: Connection<T>,
-    pub(crate) unsolicited_responses_tx: sync::Sender<UnsolicitedResponse>,
+    pub(crate) unsolicited_responses_tx: channel::Sender<UnsolicitedResponse>,
 
     /// Server responses that are not related to the current command. See also the note on
     /// [unilateral server responses in RFC 3501](https://tools.ietf.org/html/rfc3501#section-7).
-    pub unsolicited_responses: sync::Receiver<UnsolicitedResponse>,
+    pub unsolicited_responses: channel::Receiver<UnsolicitedResponse>,
 }
 
 impl<T: Read + Write + Unpin + fmt::Debug> Unpin for Session<T> {}
@@ -358,7 +358,7 @@ impl<T: Read + Write + Unpin + fmt::Debug + Send> Session<T> {
 
     // not public, just to avoid duplicating the channel creation code
     fn new(conn: Connection<T>) -> Self {
-        let (tx, rx) = sync::channel(100);
+        let (tx, rx) = channel::bounded(100);
         Session {
             conn,
             unsolicited_responses: rx,
@@ -1313,7 +1313,7 @@ impl<T: Read + Write + Unpin + fmt::Debug> Connection<T> {
     pub async fn run_command_and_check_ok(
         &mut self,
         command: &str,
-        unsolicited: Option<sync::Sender<UnsolicitedResponse>>,
+        unsolicited: Option<channel::Sender<UnsolicitedResponse>>,
     ) -> Result<()> {
         let id = self.run_command(command).await?;
         self.check_done_ok(&id, unsolicited).await?;
@@ -1324,7 +1324,7 @@ impl<T: Read + Write + Unpin + fmt::Debug> Connection<T> {
     pub(crate) async fn check_done_ok(
         &mut self,
         id: &RequestId,
-        unsolicited: Option<sync::Sender<UnsolicitedResponse>>,
+        unsolicited: Option<channel::Sender<UnsolicitedResponse>>,
     ) -> Result<()> {
         if let Some(first_res) = self.stream.next().await {
             self.check_done_ok_from(id, unsolicited, first_res?).await
@@ -1336,7 +1336,7 @@ impl<T: Read + Write + Unpin + fmt::Debug> Connection<T> {
     pub(crate) async fn check_done_ok_from(
         &mut self,
         id: &RequestId,
-        unsolicited: Option<sync::Sender<UnsolicitedResponse>>,
+        unsolicited: Option<channel::Sender<UnsolicitedResponse>>,
         mut response: ResponseData,
     ) -> Result<()> {
         loop {
@@ -1495,7 +1495,7 @@ mod tests {
         let client = mock_client!(mock_stream);
         enum Authenticate {
             Auth,
-        };
+        }
         impl Authenticator for &Authenticate {
             type Response = Vec<u8>;
             fn process(&mut self, challenge: &[u8]) -> Self::Response {

src/parse.rs

@@ -1,9 +1,9 @@
 use std::collections::HashSet;
 
+use async_std::channel;
 use async_std::io;
 use async_std::prelude::*;
 use async_std::stream::Stream;
-use async_std::sync;
 use imap_proto::{self, MailboxDatum, RequestId, Response};
 
 use crate::error::{Error, Result};
@@ -12,7 +12,7 @@ use crate::types::*;
 
 pub(crate) fn parse_names<'a, T: Stream<Item = io::Result<ResponseData>> + Unpin + Send>(
     stream: &'a mut T,
-    unsolicited: sync::Sender<UnsolicitedResponse>,
+    unsolicited: channel::Sender<UnsolicitedResponse>,
     command_tag: RequestId,
 ) -> impl Stream<Item = Result<Name>> + 'a + Send + Unpin {
     use futures::{FutureExt, StreamExt};
@@ -58,7 +58,7 @@ fn filter_sync(res: &io::Result<ResponseData>, command_tag: &RequestId) -> bool
 
 pub(crate) fn parse_fetches<'a, T: Stream<Item = io::Result<ResponseData>> + Unpin + Send>(
     stream: &'a mut T,
-    unsolicited: sync::Sender<UnsolicitedResponse>,
+    unsolicited: channel::Sender<UnsolicitedResponse>,
     command_tag: RequestId,
 ) -> impl Stream<Item = Result<Fetch>> + 'a + Send + Unpin {
     use futures::{FutureExt, StreamExt};
@@ -87,7 +87,7 @@ pub(crate) fn parse_fetches<'a, T: Stream<Item = io::Result<ResponseData>> + Unp
 
 pub(crate) fn parse_expunge<'a, T: Stream<Item = io::Result<ResponseData>> + Unpin + Send>(
     stream: &'a mut T,
-    unsolicited: sync::Sender<UnsolicitedResponse>,
+    unsolicited: channel::Sender<UnsolicitedResponse>,
     command_tag: RequestId,
 ) -> impl Stream<Item = Result<u32>> + 'a + Send {
     use futures::StreamExt;
@@ -115,7 +115,7 @@ pub(crate) fn parse_expunge<'a, T: Stream<Item = io::Result<ResponseData>> + Unp
 
 pub(crate) async fn parse_capabilities<'a, T: Stream<Item = io::Result<ResponseData>> + Unpin>(
     stream: &'a mut T,
-    unsolicited: sync::Sender<UnsolicitedResponse>,
+    unsolicited: channel::Sender<UnsolicitedResponse>,
     command_tag: RequestId,
 ) -> Result<Capabilities> {
     let mut caps: HashSet<Capability> = HashSet::new();
@@ -143,7 +143,7 @@ pub(crate) async fn parse_capabilities<'a, T: Stream<Item = io::Result<ResponseD
 
 pub(crate) async fn parse_noop<T: Stream<Item = io::Result<ResponseData>> + Unpin>(
     stream: &mut T,
-    unsolicited: sync::Sender<UnsolicitedResponse>,
+    unsolicited: channel::Sender<UnsolicitedResponse>,
     command_tag: RequestId,
 ) -> Result<()> {
     while let Some(resp) = stream
@@ -160,7 +160,7 @@ pub(crate) async fn parse_noop<T: Stream<Item = io::Result<ResponseData>> + Unpi
 
 pub(crate) async fn parse_mailbox<T: Stream<Item = io::Result<ResponseData>> + Unpin>(
     stream: &mut T,
-    unsolicited: sync::Sender<UnsolicitedResponse>,
+    unsolicited: channel::Sender<UnsolicitedResponse>,
     command_tag: RequestId,
 ) -> Result<Mailbox> {
     let mut mailbox = Mailbox::default();
@@ -252,7 +252,7 @@ pub(crate) async fn parse_mailbox<T: Stream<Item = io::Result<ResponseData>> + U
 
 pub(crate) async fn parse_ids<T: Stream<Item = io::Result<ResponseData>> + Unpin>(
     stream: &mut T,
-    unsolicited: sync::Sender<UnsolicitedResponse>,
+    unsolicited: channel::Sender<UnsolicitedResponse>,
     command_tag: RequestId,
 ) -> Result<HashSet<u32>> {
     let mut ids: HashSet<u32> = HashSet::new();
@@ -282,7 +282,7 @@ pub(crate) async fn parse_ids<T: Stream<Item = io::Result<ResponseData>> + Unpin
 // (see Section 7 of RFC 3501):
 pub(crate) async fn handle_unilateral(
     res: ResponseData,
-    unsolicited: sync::Sender<UnsolicitedResponse>,
+    unsolicited: channel::Sender<UnsolicitedResponse>,
 ) {
     // ignore these if they are not being consumed
     if unsolicited.is_full() {
@@ -291,7 +291,7 @@ pub(crate) async fn handle_unilateral(
 
     match res.parsed() {
         Response::MailboxData(MailboxDatum::Status { mailbox, status }) => {
-            unsolicited
+            let _ = unsolicited
                 .send(UnsolicitedResponse::Status {
                     mailbox: (*mailbox).into(),
                     attributes: status
@@ -307,19 +307,23 @@ pub(crate) async fn handle_unilateral(
                         })
                         .collect(),
                 })
-                .await;
+                .await; //TODO: decide what to do with result
         }
         Response::MailboxData(MailboxDatum::Recent(n)) => {
-            unsolicited.send(UnsolicitedResponse::Recent(*n)).await;
+            //TODO: decide what to do with result
+            let _ = unsolicited.send(UnsolicitedResponse::Recent(*n)).await;
         }
         Response::MailboxData(MailboxDatum::Exists(n)) => {
-            unsolicited.send(UnsolicitedResponse::Exists(*n)).await;
+            //TODO: decide what to do with result
+            let _ = unsolicited.send(UnsolicitedResponse::Exists(*n)).await;
         }
         Response::Expunge(n) => {
-            unsolicited.send(UnsolicitedResponse::Expunge(*n)).await;
+            //TODO: decide what to do with result
+            let _ = unsolicited.send(UnsolicitedResponse::Expunge(*n)).await;
         }
         _ => {
-            unsolicited.send(UnsolicitedResponse::Other(res)).await;
+            //TODO: decide what to do with result
+            let _ = unsolicited.send(UnsolicitedResponse::Other(res)).await;
         }
     }
 }
@@ -350,7 +354,7 @@ mod tests {
             input_stream(&["* CAPABILITY IMAP4rev1 STARTTLS AUTH=GSSAPI LOGINDISABLED\r\n"]);
 
         let mut stream = async_std::stream::from_iter(responses);
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let id = RequestId("A0001".into());
         let capabilities = parse_capabilities(&mut stream, send, id).await.unwrap();
         // shouldn't be any unexpected responses parsed
@@ -368,7 +372,7 @@ mod tests {
         let responses = input_stream(&["* CAPABILITY IMAP4REV1 STARTTLS\r\n"]);
         let mut stream = async_std::stream::from_iter(responses);
 
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let id = RequestId("A0001".into());
         let capabilities = parse_capabilities(&mut stream, send, id).await.unwrap();
 
@@ -383,7 +387,7 @@ mod tests {
     #[async_std::test]
     #[should_panic]
     async fn parse_capability_invalid_test() {
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&["* JUNK IMAP4rev1 STARTTLS AUTH=GSSAPI LOGINDISABLED\r\n"]);
         let mut stream = async_std::stream::from_iter(responses);
 
@@ -396,7 +400,7 @@ mod tests {
 
     #[async_std::test]
     async fn parse_names_test() {
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&["* LIST (\\HasNoChildren) \".\" \"INBOX\"\r\n"]);
         let mut stream = async_std::stream::from_iter(responses);
 
@@ -417,7 +421,7 @@ mod tests {
 
     #[async_std::test]
     async fn parse_fetches_empty() {
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&[]);
         let mut stream = async_std::stream::from_iter(responses);
         let id = RequestId("a".into());
@@ -432,7 +436,7 @@ mod tests {
 
     #[async_std::test]
     async fn parse_fetches_test() {
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&[
             "* 24 FETCH (FLAGS (\\Seen) UID 4827943)\r\n",
             "* 25 FETCH (FLAGS (\\Seen))\r\n",
@@ -462,7 +466,7 @@ mod tests {
     #[async_std::test]
     async fn parse_fetches_w_unilateral() {
         // https://github.com/mattnenterprise/rust-imap/issues/81
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&["* 37 FETCH (UID 74)\r\n", "* 1 RECENT\r\n"]);
         let mut stream = async_std::stream::from_iter(responses);
         let id = RequestId("a".into());
@@ -480,7 +484,7 @@ mod tests {
 
     #[async_std::test]
     async fn parse_names_w_unilateral() {
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&[
             "* LIST (\\HasNoChildren) \".\" \"INBOX\"\r\n",
             "* 4 EXPUNGE\r\n",
@@ -506,7 +510,7 @@ mod tests {
 
     #[async_std::test]
     async fn parse_capabilities_w_unilateral() {
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&[
             "* CAPABILITY IMAP4rev1 STARTTLS AUTH=GSSAPI LOGINDISABLED\r\n",
             "* STATUS dev.github (MESSAGES 10 UIDNEXT 11 UIDVALIDITY 1408806928 UNSEEN 0)\r\n",
@@ -541,7 +545,7 @@ mod tests {
 
     #[async_std::test]
     async fn parse_ids_w_unilateral() {
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&[
             "* SEARCH 23 42 4711\r\n",
             "* 1 RECENT\r\n",
@@ -571,7 +575,7 @@ mod tests {
 
     #[async_std::test]
     async fn parse_ids_test() {
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&[
                 "* SEARCH 1600 1698 1739 1781 1795 1885 1891 1892 1893 1898 1899 1901 1911 1926 1932 1933 1993 1994 2007 2032 2033 2041 2053 2062 2063 2065 2066 2072 2078 2079 2082 2084 2095 2100 2101 2102 2103 2104 2107 2116 2120 2135 2138 2154 2163 2168 2172 2189 2193 2198 2199 2205 2212 2213 2221 2227 2267 2275 2276 2295 2300 2328 2330 2332 2333 2334\r\n",
                 "* SEARCH 2335 2336 2337 2338 2339 2341 2342 2347 2349 2350 2358 2359 2362 2369 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2390 2392 2397 2400 2401 2403 2405 2409 2411 2414 2417 2419 2420 2424 2426 2428 2439 2454 2456 2467 2468 2469 2490 2515 2519 2520 2521\r\n",
@@ -604,7 +608,7 @@ mod tests {
 
     #[async_std::test]
     async fn parse_ids_search() {
-        let (send, recv) = sync::channel(10);
+        let (send, recv) = channel::bounded(10);
         let responses = input_stream(&["* SEARCH\r\n"]);
         let mut stream = async_std::stream::from_iter(responses);