ntex-io 3.9.2

Utilities for abstracting io streams
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

bitflags::bitflags! {
    #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
    pub struct Flags: u16 {
        /// io is closed
        const IO_STOPPED          = 0b0000_0000_0000_0001;
        /// shutdown io tasks
        const IO_STOPPING         = 0b0000_0000_0000_0010;
        /// shutting down filters
        const IO_STOPPING_FILTERS = 0b0000_0000_0000_0100;

        /// pause io read
        const RD_PAUSED           = 0b0000_0000_0001_0000;
        /// read any data and notify dispatcher
        const RD_NOTIFY           = 0b0000_0000_0010_0000;

        /// new data is available in read buffer
        const BUF_R_READY         = 0b0000_0000_0100_0000;
        /// read buffer is full
        const BUF_R_FULL          = 0b0000_0000_1000_0000;

        /// wait while write task flushes buf
        const BUF_W_MUST_FLUSH    = 0b0000_0001_0000_0000;
        /// write buffer is full
        const BUF_W_BACKPRESSURE  = 0b0000_0010_0000_0000;

        /// write task paused
        const WR_PAUSED           = 0b0000_0100_0000_0000;
        /// wait for write completion task
        const WR_TASK_WAIT        = 0b0000_1000_0000_0000;

        /// timeout occurred
        const DSP_TIMEOUT         = 0b0010_0000_0000_0000;
    }
}

impl Flags {
    pub(crate) fn is_stopped(self) -> bool {
        self.contains(Flags::IO_STOPPED)
    }

    pub(crate) fn is_task_waiting_for_write(self) -> bool {
        self.contains(Flags::WR_TASK_WAIT)
    }

    pub(crate) fn is_waiting_for_write(self) -> bool {
        self.intersects(Flags::BUF_W_MUST_FLUSH | Flags::BUF_W_BACKPRESSURE)
    }

    pub(crate) fn waiting_for_write_is_done(&mut self) {
        self.remove(Flags::BUF_W_MUST_FLUSH | Flags::BUF_W_BACKPRESSURE);
    }

    pub(crate) fn task_waiting_for_write_is_done(&mut self) {
        self.remove(Flags::WR_TASK_WAIT);
    }

    pub(crate) fn is_read_buf_ready(self) -> bool {
        self.contains(Flags::BUF_R_READY)
    }

    pub(crate) fn is_waiting_for_read(self) -> bool {
        self.contains(Flags::RD_NOTIFY)
    }

    pub(crate) fn cannot_read(self) -> bool {
        self.intersects(Flags::RD_PAUSED | Flags::BUF_R_FULL)
    }

    pub(crate) fn cleanup_read_flags(&mut self) {
        self.remove(Flags::BUF_R_READY | Flags::BUF_R_FULL | Flags::RD_PAUSED);
    }
}