rsynko-reqwest 0.1.0

Reqwest and filesystem interpreters for Rsynko
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use std::sync::{Arc, Condvar, Mutex};

/// Controls cooperative suspension of one streaming download.
#[derive(Clone, Debug)]
pub struct RuntimePause {
    state: Arc<(Mutex<RuntimeControlState>, Condvar)>,
}

#[derive(Debug)]
struct RuntimeControlState {
    paused: bool,
    cancelled: bool,
}

impl RuntimePause {
    /// Constructs a running transfer control.
    #[must_use]
    pub fn running() -> Self {
        Self {
            state: (
                Mutex::new(RuntimeControlState {
                    paused: false,
                    cancelled: false,
                }),
                Condvar::new(),
            )
                .into(),
        }
    }

    /// Sets whether retrieval waits before reading its next chunk.
    pub fn set_paused(&self, paused: bool) {
        let (state, changed) = &*self.state;
        state
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .paused = paused;
        if !paused {
            changed.notify_all();
        }
    }

    /// Cancels retrieval and wakes a suspended reader.
    pub fn cancel(&self) {
        let (state, changed) = &*self.state;
        state
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .cancelled = true;
        changed.notify_all();
    }

    pub(crate) fn wait_until_running(&self) -> bool {
        let (state, changed) = &*self.state;
        let mut paused = state
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner);
        while paused.paused && !paused.cancelled {
            paused = changed
                .wait(paused)
                .unwrap_or_else(std::sync::PoisonError::into_inner);
        }
        !paused.cancelled
    }
}

#[cfg(test)]
mod tests {
    use super::RuntimePause;
    use std::sync::mpsc;
    use std::thread;
    use std::time::Duration;

    #[test]
    fn paused_reader_waits_until_resume() {
        let pause = RuntimePause::running();
        pause.set_paused(true);
        let waiting = pause.clone();
        let (sender, receiver) = mpsc::channel();
        let worker = thread::spawn(move || {
            waiting.wait_until_running();
            sender.send(()).expect("observer remains connected");
        });

        assert!(receiver.recv_timeout(Duration::from_millis(20)).is_err());
        pause.set_paused(false);
        receiver
            .recv_timeout(Duration::from_secs(1))
            .expect("reader resumed");
        worker.join().expect("pause worker");
    }

    #[test]
    fn cancellation_wakes_a_paused_reader() {
        let pause = RuntimePause::running();
        pause.set_paused(true);
        let waiting = pause.clone();
        let (sender, receiver) = mpsc::channel();
        let worker = thread::spawn(move || {
            sender
                .send(waiting.wait_until_running())
                .expect("observer remains connected");
        });

        pause.cancel();
        assert!(
            !receiver
                .recv_timeout(Duration::from_secs(1))
                .expect("cancelled")
        );
        worker.join().expect("pause worker");
    }
}