Struct InterruptReader 

pub struct InterruptReader<R> { /* private fields */ }

An interruptable, buffered Reader.

This reader is created by wrapping a Read struct in the interrupt_read::pair function, which also returns an Interruptor, which is capable of sending interrupt signals, which make any read operations on the InterruptReader return an error of kind ErrorKind::Other, with a payload of InterruptReceived.

When an interrupt is received, the underlying data is not lost, it still exists, and if you call a reading function again, it will be retrieved, unless another interrupt is sent before that.

You can check if an std::io::Error is of this type by calling the is_interrupt function.

Examples

One potential application of this struct is if you want to stop a thread that is reading from the stdout of a child process without necessarily terminating said childrop_:

use std::{
    io::{BufRead, ErrorKind},
    process::{Child, Command, Stdio},
    time::Duration,
};

use interrupt_read::{is_interrupt, pair};

struct ChildKiller(Child);
impl Drop for ChildKiller {
    fn drop(&mut self) {
        _ = self.0.kill();
    }
}

// Prints "hello\n" every second forever.
let mut child = Command::new("bash")
    .args(["-c", r#"while true; do echo "hello"; sleep 1; done"#])
    .stdout(Stdio::piped())
    .spawn()
    .unwrap();

let (mut stdout, interruptor) = pair(child.stdout.take().unwrap());
let _child_killer = ChildKiller(child);

let join_handle = std::thread::spawn(move || {
    let mut string = String::new();
    loop {
        match stdout.read_line(&mut string) {
            Ok(0) => break Ok(string),
            Ok(_) => {}
            Err(err) if is_interrupt(&err) => {
                break Ok(string);
            }
            Err(err) => break Err(err),
        }
    }
});

std::thread::sleep(Duration::new(3, 1_000_000));

interruptor.interrupt()?;

let result = join_handle.join().unwrap()?;

assert_eq!(result, "hello\nhello\nhello\n");

Ok(())

Implementations

impl<R: Read> InterruptReader<R>

pub fn into_inner(self) -> Result<R>

Unwraps this InterruptReader, returning the underlying reader.

Note that any leftover data in the internal buffer is lost. Therefore, a following read from the underlying reader may lead to data loss.

This may return Err if the underlying joined thread has panicked, probably because the Reader has done so.

Trait Implementations

impl<R: Read> BufRead for InterruptReader<R>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

fn consume(&mut self, amount: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.

fn has_data_left(&mut self) -> Result<bool, Error>

🔬This is a nightly-only experimental API. (buf_read_has_data_left)

Checks if there is any data left to be read.

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<R: Debug> Debug for InterruptReader<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R: Read> Read for InterruptReader<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.