tor_proto/
util.rs

1//! Utilities used for the tor protocol.
2
3pub(crate) mod ct;
4pub(crate) mod err;
5pub(crate) mod keyed_futures_unordered;
6pub(crate) mod notify;
7pub(crate) mod poll_all;
8pub(crate) mod sink_blocker;
9pub(crate) mod skew;
10pub(crate) mod sometimes_unbounded_sink;
11pub(crate) mod stream_poll_set;
12pub(crate) mod timeout;
13pub(crate) mod ts;
14pub(crate) mod tunnel_activity;
15
16use futures::Sink;
17use std::pin::Pin;
18use std::task::{Context, Poll};
19
20/// Extension trait for `Sink`
21pub(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    fn poll_ready_unpin_bool(&mut self, cx: &mut Context<'_>) -> Result<bool, Self::Error>
28    where
29        Self: Unpin,
30    {
31        Ok(match Sink::poll_ready(Pin::new(self), cx) {
32            Poll::Ready(Ok(())) => true,
33            Poll::Ready(Err(e)) => return Err(e),
34            Poll::Pending => false,
35        })
36    }
37}
38impl<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"))]
45pub(crate) fn fake_mq<A: crate::memquota::SpecificAccount>() -> A {
46    A::new_noop()
47}
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)]
53pub(crate) struct DummyTimeoutEstimator;
54
55#[cfg(test)]
56impl crate::client::circuit::TimeoutEstimator for DummyTimeoutEstimator {
57    fn circuit_build_timeout(&self, _length: usize) -> std::time::Duration {
58        // Dummy value
59        std::time::Duration::from_millis(1000)
60    }
61}
tor_proto/util.rs

tor_proto/
util.rs
