Cancelamento

Descartar uma future implica que ela nunca pode ser consultada novamente. Isso Ă© chamado de cancelamento e pode ocorrer em qualquer ponto de await. Cuidado Ă© necessĂĄrio para garantir que o sistema funcione corretamente mesmo quando as futures sĂŁo canceladas. Por exemplo, nĂŁo deve travar ou perder dados.

use std::io::{self, ErrorKind};
use std::time::Duration;
use tokio::io::{AsyncReadExt, AsyncWriteExt, DuplexStream};

struct LinesReader {
    stream: DuplexStream,
}

impl LinesReader {
    fn new(stream: DuplexStream) -> Self {
        Self { stream }
    }

    async fn next(&mut self) -> io::Result<Option<String>> {
        let mut bytes = Vec::new();
        let mut buf = [0];
        while self.stream.read(&mut buf[..]).await? != 0 {
            bytes.push(buf[0]);
            if buf[0] == b'\n' {
                break;
            }
        }
        if bytes.is_empty() {
            return Ok(None);
        }
        let s = String::from_utf8(bytes)
            .map_err(|_| io::Error::new(ErrorKind::InvalidData, "nĂŁo UTF-8"))?;
        Ok(Some(s))
    }
}

async fn slow_copy(source: String, mut dest: DuplexStream) -> std::io::Result<()> {
    for b in source.bytes() {
        dest.write_u8(b).await?;
        tokio::time::sleep(Duration::from_millis(10)).await
    }
    Ok(())
}

#[tokio::main]
async fn main() -> std::io::Result<()> {
    let (client, server) = tokio::io::duplex(5);
    let handle = tokio::spawn(slow_copy("hi\nthere\n".to_owned(), client));

    let mut lines = LinesReader::new(server);
    let mut interval = tokio::time::interval(Duration::from_millis(60));
    loop {
        tokio::select! {
            _ = interval.tick() => println!("tick!"),
            line = lines.next() => if let Some(l) = line? {
                print!("{}", l)
            } else {
                break
            },
        }
    }
    handle.await.unwrap()?;
    Ok(())
}

  • O compilador nĂŁo ajuda com a segurança do cancelamento. VocĂȘ precisa ler a documentação da API e considerar qual estado sua async fn mantĂ©m.

  • Diferentemente de panic e ?, o cancelamento faz parte do fluxo de controle normal (vs tratamento de erros).

  • O exemplo perde partes da string.

    • Sempre que o ramo tick() termina primeiro, next() e seu buf sĂŁo descartados.

    • LinesReader pode ser tornado seguro para cancelamento tornando buf parte da estrutura:

      #![allow(unused)]
fn main() {
struct LinesReader {
    stream: DuplexStream,
    bytes: Vec<u8>,
    buf: [u8; 1],
}

impl LinesReader {
    fn new(stream: DuplexStream) -> Self {
        Self { stream, bytes: Vec::new(), buf: [0] }
    }
    async fn next(&mut self) -> io::Result<Option<String>> {
        // prefixe buf e bytes com self.
        // ...
        let raw = std::mem::take(&mut self.bytes);
        let s = String::from_utf8(raw)
        // ...
    }
}
}

  • Interval::tick Ă© seguro para cancelamento porque mantĂ©m o controle de se um tick foi ‘entregue’.

  • AsyncReadExt::read Ă© seguro para cancelamento porque ou retorna ou nĂŁo lĂȘ dados.

  • AsyncBufReadExt::read_line Ă© semelhante ao exemplo e nĂŁo Ă© seguro para cancelamento. Consulte sua documentação para detalhes e alternativas.