1
//! Utilities used for the tor protocol.
2

            
3
pub(crate) mod ct;
4
pub(crate) mod err;
5
pub(crate) mod keyed_futures_unordered;
6
pub(crate) mod notify;
7
pub(crate) mod poll_all;
8
pub(crate) mod sink_blocker;
9
pub(crate) mod skew;
10
pub(crate) mod sometimes_unbounded_sink;
11
pub(crate) mod stream_poll_set;
12
pub(crate) mod timeout;
13
pub(crate) mod ts;
14
pub(crate) mod tunnel_activity;
15

            
16
use futures::Sink;
17
use std::pin::Pin;
18
use std::task::{Context, Poll};
19

            
20
/// Extension trait for `Sink`
21
pub(crate) trait SinkExt<T>: Sink<T> {
22
    /// Calls `futures::Sink::poll_ready` but requires `Unpin` and returns `bool`
23
    ///
24
    /// Various gnarly places in the circuit reactor find this convenient.
25
    ///
26
    /// TODO #1397 (circuit reactor) probably remove this when the circuit reactor is rewritten.
27
44
    fn poll_ready_unpin_bool(&mut self, cx: &mut Context<'_>) -> Result<bool, Self::Error>
28
44
    where
29
44
        Self: Unpin,
30
    {
31
44
        Ok(match Sink::poll_ready(Pin::new(self), cx) {
32
44
            Poll::Ready(Ok(())) => true,
33
            Poll::Ready(Err(e)) => return Err(e),
34
            Poll::Pending => false,
35
        })
36
44
    }
37
}
38
impl<T, S: Sink<T>> SinkExt<T> for S {}
39

            
40
/// Convenience alias for
41
/// [`memquota::SpecificAccount::new_noop()`](crate::memquota::SpecificAccount::new_noop())
42
///
43
/// Available only in tests, which makes diff hunks which call this more obviously correct.
44
#[cfg(any(test, feature = "testing"))]
45
1846
pub(crate) fn fake_mq<A: crate::memquota::SpecificAccount>() -> A {
46
1846
    A::new_noop()
47
1846
}
48

            
49
/// A timeout estimator that returns dummy values.
50
///
51
/// Used in the tests where the timeout estimates aren't relevant.
52
#[cfg(test)]
53
pub(crate) struct DummyTimeoutEstimator;
54

            
55
#[cfg(test)]
56
impl crate::client::circuit::TimeoutEstimator for DummyTimeoutEstimator {
57
68
    fn circuit_build_timeout(&self, _length: usize) -> std::time::Duration {
58
        // Dummy value
59
68
        std::time::Duration::from_millis(1000)
60
68
    }
61
}