1#![cfg_attr(docsrs, feature(doc_cfg))]
2#![doc = include_str!("../README.md")]
3#![allow(renamed_and_removed_lints)] #![allow(unknown_lints)] #![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)] #![allow(clippy::uninlined_format_args)]
40#![allow(clippy::significant_drop_in_scrutinee)] #![allow(clippy::result_large_err)] #![allow(clippy::needless_raw_string_hashes)] #![allow(clippy::needless_lifetimes)] #![allow(mismatched_lifetime_syntaxes)] #![cfg_attr(not(all(feature = "full", feature = "experimental")), allow(unused))]
49
50#[cfg(feature = "parse2")]
51#[macro_use]
52pub mod parse2;
53#[cfg(feature = "hs-service")]
54pub(crate) mod build;
55#[macro_use]
56pub(crate) mod parse;
57pub mod doc;
58mod err;
59pub mod types;
60mod util;
61
62#[doc(hidden)]
63pub use derive_deftly;
64
65#[doc(hidden)]
68pub use util::batching_split_before;
69
70pub use err::{BuildError, Error, NetdocErrorKind, Pos};
71
72#[cfg(feature = "hs-service")]
73#[cfg_attr(docsrs, doc(cfg(feature = "hs-service")))]
74pub use build::NetdocBuilder;
75
76pub type Result<T> = std::result::Result<T, Error>;
78
79pub type BuildResult<T> = std::result::Result<T, BuildError>;
82
83#[derive(PartialEq, Debug, Eq)]
86#[allow(clippy::exhaustive_enums)]
87pub enum AllowAnnotations {
88 AnnotationsAllowed,
94 AnnotationsNotAllowed,
96}
97
98pub fn supported_protocols() -> tor_protover::Protocols {
101 use tor_protover::named::*;
102 [
105 DESC_CROSSSIGN,
106 DESC_NO_TAP,
107 DESC_FAMILY_IDS,
108 MICRODESC_ED25519_KEY,
109 MICRODESC_NO_TAP,
110 CONS_ED25519_MDS,
111 ]
112 .into_iter()
113 .collect()
114}
115
116#[cfg(test)]
117mod test {
118 #![allow(clippy::bool_assert_comparison)]
120 #![allow(clippy::clone_on_copy)]
121 #![allow(clippy::dbg_macro)]
122 #![allow(clippy::mixed_attributes_style)]
123 #![allow(clippy::print_stderr)]
124 #![allow(clippy::print_stdout)]
125 #![allow(clippy::single_char_pattern)]
126 #![allow(clippy::unwrap_used)]
127 #![allow(clippy::unchecked_duration_subtraction)]
128 #![allow(clippy::useless_vec)]
129 #![allow(clippy::needless_pass_by_value)]
130 use super::*;
133
134 #[test]
135 fn protocols() {
136 let pr = supported_protocols();
137 let expected = "Cons=2 Desc=2-4 Microdesc=2-3".parse().unwrap();
138 assert_eq!(pr, expected);
139 }
140}