CancelReader
A cancelable reader for Go
This package is based on the fantastic work of Erik Geiser in Charm's Bubble Tea framework.
Usage
NewReader returns a reader with a Cancel function. If the input reader is an *os.File, the cancel function can be used to interrupt a blocking Read call. In this case, the cancel function returns true if the call was canceled successfully. If the input reader is not an *os.File, the cancel function does nothing and always returns false.
r, err := cancelreader.NewReader(file)
if err != nil {
// handle error
...
}
// cancel after five seconds
go func() {
time.Sleep(5 * time.Second)
r.Cancel()
}()
// keep reading
for {
var buf [1024]byte
_, err := r.Read(buf[:])
if errors.Is(err, cancelreader.ErrCanceled) {
fmt.Println("canceled!")
break
}
if err != nil {
// handle other errors
...
}
// handle data
...
}
Implementations
- The Linux implementation is based on the epoll mechanism
- The BSD and macOS implementation is based on the kqueue mechanism
- The generic Unix implementation is based on the posix select syscall
Caution
The Windows implementation is based on WaitForMultipleObject with overlapping reads from CONIN$. At this point it only supports canceling reads from os.Stdin.
2 Nov 4, 2021
0 Nov 7, 2021
1.6k Jan 2, 2023
1 Nov 24, 2021
0 Nov 28, 2021
0 Dec 12, 2021
2 May 7, 2022
0 Dec 23, 2021
8 Oct 30, 2022
85 Nov 24, 2022
143 Dec 25, 2022
0 Jan 14, 2022
0 Jan 25, 2022
1 Feb 26, 2022
1 Dec 25, 2022
1 Feb 13, 2022
91 Jan 2, 2023
11 Oct 16, 2022
167 Dec 19, 2022
205 Dec 1, 2022
243 Dec 30, 2022
1.5k Dec 29, 2022
186 Oct 12, 2022
72 Dec 14, 2022
11.3k Dec 30, 2022
4.4k Jan 3, 2023
5 Dec 1, 2022
1 Oct 25, 2021