fedimint_arti_client/
lib.rs

1#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
2#![doc = include_str!("../README.md")]
3// @@ begin lint list maintained by maint/add_warning @@
4#![allow(renamed_and_removed_lints)] // @@REMOVE_WHEN(ci_arti_stable)
5#![allow(unknown_lints)] // @@REMOVE_WHEN(ci_arti_nightly)
6#![warn(missing_docs)]
7#![warn(noop_method_call)]
8#![warn(unreachable_pub)]
9#![warn(clippy::all)]
10#![deny(clippy::await_holding_lock)]
11#![deny(clippy::cargo_common_metadata)]
12#![deny(clippy::cast_lossless)]
13#![deny(clippy::checked_conversions)]
14#![warn(clippy::cognitive_complexity)]
15#![deny(clippy::debug_assert_with_mut_call)]
16#![deny(clippy::exhaustive_enums)]
17#![deny(clippy::exhaustive_structs)]
18#![deny(clippy::expl_impl_clone_on_copy)]
19#![deny(clippy::fallible_impl_from)]
20#![deny(clippy::implicit_clone)]
21#![deny(clippy::large_stack_arrays)]
22#![warn(clippy::manual_ok_or)]
23#![deny(clippy::missing_docs_in_private_items)]
24#![warn(clippy::needless_borrow)]
25#![warn(clippy::needless_pass_by_value)]
26#![warn(clippy::option_option)]
27#![deny(clippy::print_stderr)]
28#![deny(clippy::print_stdout)]
29#![warn(clippy::rc_buffer)]
30#![deny(clippy::ref_option_ref)]
31#![warn(clippy::semicolon_if_nothing_returned)]
32#![warn(clippy::trait_duplication_in_bounds)]
33#![deny(clippy::unchecked_duration_subtraction)]
34#![deny(clippy::unnecessary_wraps)]
35#![warn(clippy::unseparated_literal_suffix)]
36#![deny(clippy::unwrap_used)]
37#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness
38#![allow(clippy::uninlined_format_args)]
39#![allow(clippy::significant_drop_in_scrutinee)] // arti/-/merge_requests/588/#note_2812945
40#![allow(clippy::result_large_err)] // temporary workaround for arti#587
41#![allow(clippy::needless_raw_string_hashes)] // complained-about code is fine, often best
42//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
43
44mod address;
45mod builder;
46mod client;
47#[cfg(feature = "rpc")]
48pub mod rpc;
49mod util;
50
51pub mod config;
52pub mod status;
53
54pub use address::{DangerouslyIntoTorAddr, IntoTorAddr, TorAddr, TorAddrError};
55pub use builder::{TorClientBuilder, MAX_LOCAL_RESOURCE_TIMEOUT};
56pub use client::{BootstrapBehavior, DormantMode, StreamPrefs, TorClient};
57pub use config::TorClientConfig;
58
59pub use tor_circmgr::isolation;
60pub use tor_circmgr::IsolationToken;
61pub use tor_error::{ErrorKind, HasKind};
62pub use tor_proto::stream::{DataReader, DataStream, DataWriter};
63
64mod err;
65pub use err::{Error, ErrorHint, HintableError};
66
67#[cfg(feature = "error_detail")]
68pub use err::ErrorDetail;
69
70/// Alias for the [`Result`] type corresponding to the high-level [`Error`].
71pub type Result<T> = std::result::Result<T, Error>;
72
73#[cfg(feature = "experimental-api")]
74pub use builder::DirProviderBuilder;
75
76#[cfg(feature = "geoip")]
77#[cfg_attr(docsrs, doc(cfg(feature = "geoip")))]
78pub use tor_geoip::CountryCode;
fedimint_arti_client/lib.rs

fedimint_arti_client/
lib.rs
