blob: 6c1417d3b80deb872a93219474168cc47dfdc7cd (
plain)
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
|
pub mod builder;
mod config;
use builder::TorRelayBuilder;
use tor_rtcompat::Runtime;
// Only rustls is supported.
#[cfg(all(feature = "rustls", any(feature = "async-std", feature = "tokio")))]
use tor_rtcompat::PreferredRuntime;
/// Represent an active Relay on the Tor network.
#[derive(Clone)]
pub struct TorRelay<R: Runtime> {
/// Asynchronous runtime object.
#[allow(unused)] // TODO RELAY remove
runtime: R,
}
/// TorRelay can't be used with native-tls due to the lack of RFC5705 (keying material exporter).
#[cfg(all(feature = "rustls", any(feature = "async-std", feature = "tokio")))]
impl TorRelay<PreferredRuntime> {
/// Return a new builder for creating a TorRelay object.
///
/// # Panics
///
/// If Tokio is being used (the default), panics if created outside the context of a currently
/// running Tokio runtime. See the documentation for `tokio::runtime::Handle::current` for
/// more information.
///
/// If using `async-std`, either take care to ensure Arti is not compiled with Tokio support,
/// or manually create an `async-std` runtime using [`tor_rtcompat`] and use it with
/// [`TorRelay::with_runtime`].
pub fn builder() -> TorRelayBuilder<PreferredRuntime> {
let runtime = PreferredRuntime::current().expect(
"TorRelay could not get an asynchronous runtime; are you running in the right context?",
);
TorRelayBuilder::new(runtime)
}
}
impl<R: Runtime> TorRelay<R> {
/// Return a new builder for creating TorRelay objects, with a custom provided [`Runtime`].
///
/// See the [`tor_rtcompat`] crate for more information on custom runtimes.
pub fn with_runtime(runtime: R) -> TorRelayBuilder<R> {
TorRelayBuilder::new(runtime)
}
/// Return a TorRelay object.
pub(crate) fn create_inner(runtime: R) -> Self {
Self { runtime }
}
}
|
