Cancellation

Dropping a future implies it can never be polled again. This is called cancellation and it can occur at any await point. Care is needed to ensure the system works correctly even when futures are cancelled. For example, it shouldn’t deadlock or lose data.

  1. use std::io;
  2. use std::time::Duration;
  3. use tokio::io::{AsyncReadExt, AsyncWriteExt, DuplexStream};
  5. struct LinesReader {
  6.     stream: DuplexStream,
  7. }
  9. impl LinesReader {
  10.     fn new(stream: DuplexStream) -> Self {
  11.         Self { stream }
  12.     }
  14.     async fn next(&mut self) -> io::Result<Option<String>> {
  15.         let mut bytes = Vec::new();
  16.         let mut buf = [0];
  17.         while self.stream.read(&mut buf[..]).await? != 0 {
  18.             bytes.push(buf[0]);
  19.             if buf[0] == b'\n' {
  20.                 break;
  21.             }
  22.         }
  23.         if bytes.is_empty() {
  24.             return Ok(None);
  25.         }
  26.         let s = String::from_utf8(bytes)
  27.             .map_err(|_| io::Error::new(io::ErrorKind::InvalidData, "not UTF-8"))?;
  28.         Ok(Some(s))
  29.     }
  30. }
  32. async fn slow_copy(source: String, mut dest: DuplexStream) -> io::Result<()> {
  33.     for b in source.bytes() {
  34.         dest.write_u8(b).await?;
  35.         tokio::time::sleep(Duration::from_millis(10)).await
  36.     }
  37.     Ok(())
  38. }
  40. #[tokio::main]
  41. async fn main() -> io::Result<()> {
  42.     let (client, server) = tokio::io::duplex(5);
  43.     let handle = tokio::spawn(slow_copy("hi\nthere\n".to_owned(), client));
  45.     let mut lines = LinesReader::new(server);
  46.     let mut interval = tokio::time::interval(Duration::from_millis(60));
  47.     loop {
  48.         tokio::select! {
  49.             _ = interval.tick() => println!("tick!"),
  50.             line = lines.next() => if let Some(l) = line? {
  51.                 print!("{}", l)
  52.             } else {
  53.                 break
  54.             },
  55.         }
  56.     }
  57.     handle.await.unwrap()?;
  58.     Ok(())
  59. }

This slide should take about 18 minutes.

  • The compiler doesn’t help with cancellation-safety. You need to read API documentation and consider what state your async fn holds.

  • Unlike panic and ?, cancellation is part of normal control flow (vs error-handling).

  • The example loses parts of the string.

    • Whenever the tick() branch finishes first, next() and its buf are dropped.

    • LinesReader can be made cancellation-safe by making buf part of the struct:

      1. #![allow(unused)]
      2. fn main() {
      3. struct LinesReader {
      4.     stream: DuplexStream,
      5.     bytes: Vec<u8>,
      6.     buf: [u8; 1],
      7. }
      9. impl LinesReader {
      10.     fn new(stream: DuplexStream) -> Self {
      11.         Self { stream, bytes: Vec::new(), buf: [0] }
      12.     }
      13.     async fn next(&mut self) -> io::Result<Option<String>> {
      14.         // prefix buf and bytes with self.
      15.         // ...
      16.         let raw = std::mem::take(&mut self.bytes);
      17.         let s = String::from_utf8(raw)
      18.             .map_err(|_| io::Error::new(io::ErrorKind::InvalidData, "not UTF-8"))?;
      19.         // ...
      20.     }
      21. }
      22. }

  • Interval::tick is cancellation-safe because it keeps track of whether a tick has been ‘delivered’.

  • AsyncReadExt::read is cancellation-safe because it either returns or doesn’t read data.

  • AsyncBufReadExt::read_line is similar to the example and isn’t cancellation-safe. See its documentation for details and alternatives.