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#![deny(clippy::mod_module_files)]
38#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness
39#![allow(clippy::uninlined_format_args)]
40#![allow(clippy::significant_drop_in_scrutinee)] // arti/-/merge_requests/588/#note_2812945
41#![allow(clippy::result_large_err)] // temporary workaround for arti#587
42#![allow(clippy::needless_raw_string_hashes)] // complained-about code is fine, often best
43#![allow(clippy::needless_lifetimes)] // See arti#1765
44//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
45
46// TODO #1645 (either remove this, or decide to have it everywhere)
47#![cfg_attr(not(all(feature = "full", feature = "experimental")), allow(unused))]
48
49mod address;
50mod builder;
51mod client;
52#[cfg(feature = "rpc")]
53pub mod rpc;
54mod util;
55
56pub mod config;
57pub mod status;
58
59pub use address::{DangerouslyIntoTorAddr, IntoTorAddr, TorAddr, TorAddrError};
60pub use builder::{TorClientBuilder, MAX_LOCAL_RESOURCE_TIMEOUT};
61pub use client::{BootstrapBehavior, DormantMode, InertTorClient, StreamPrefs, TorClient};
62pub use config::TorClientConfig;
63
64pub use tor_circmgr::isolation;
65pub use tor_circmgr::IsolationToken;
66pub use tor_error::{ErrorKind, HasKind};
67pub use tor_proto::stream::{DataReader, DataStream, DataWriter};
68
69mod err;
70pub use err::{Error, ErrorHint, HintableError};
71
72#[cfg(feature = "error_detail")]
73pub use err::ErrorDetail;
74
75/// Alias for the [`Result`] type corresponding to the high-level [`Error`].
76pub type Result<T> = std::result::Result<T, Error>;
77
78#[cfg(feature = "experimental-api")]
79pub use builder::DirProviderBuilder;
80
81#[cfg(all(feature = "onion-service-client", feature = "experimental-api"))]
82#[cfg_attr(
83    docsrs,
84    doc(cfg(all(feature = "onion-service-client", feature = "experimental-api")))
85)]
86pub use {
87    tor_hscrypto::pk::{HsClientDescEncKey, HsId},
88    tor_keymgr::KeystoreSelector,
89};
90
91#[cfg(feature = "geoip")]
92#[cfg_attr(docsrs, doc(cfg(feature = "geoip")))]
93pub use tor_geoip::CountryCode;
arti_client/lib.rs

arti_client/
lib.rs
