tor_netdoc/
lib.rs

1#![cfg_attr(docsrs, feature(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#![allow(clippy::cognitive_complexity)] // See arti#2556
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_time_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#![allow(mismatched_lifetime_syntaxes)] // temporary workaround for arti#2060
45#![allow(clippy::collapsible_if)] // See arti#2342
46#![deny(clippy::unused_async)]
47#![deny(clippy::string_slice)] // See arti#2571
48//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
49
50// TODO #1645 (either remove this, or decide to have it everywhere)
51#![cfg_attr(not(all(feature = "full", feature = "experimental")), allow(unused))]
52#![allow(clippy::redundant_field_names)] // TODO beta clippy bug, rust-clippy/issues/17525
53
54#[macro_use]
55mod util;
56#[macro_use]
57mod derive_common;
58#[macro_use]
59pub mod parse2;
60#[cfg(any(test, feature = "testing"))]
61#[macro_use]
62pub mod test_support;
63#[macro_use]
64pub mod encode;
65#[macro_use]
66pub(crate) mod parse;
67pub mod doc;
68mod err;
69pub mod types;
70
71#[cfg(test)]
72mod test2;
73
74#[cfg(any(test, feature = "testing"))]
75pub mod testdata_live;
76
77#[doc(hidden)]
78pub use derive_deftly;
79
80// Use `#[doc(hidden)]` rather than pub(crate), because otherwise the doctest
81// doesn't work.
82#[doc(hidden)]
83pub use util::batching_split_before;
84
85pub use err::{BuildError, Error, ExpectedConstantString, NetdocErrorKind, Pos};
86
87pub use util::rangemap_ext::rangemap_mutate_range;
88
89#[cfg(any(test, feature = "testing"))]
90pub use test_support::{assert_eq_or_diff, parse_testcase_from_netdoc};
91
92pub use encode::NetdocBuilder;
93
94/// Alias for the Result type returned by most objects in this module.
95pub type Result<T> = std::result::Result<T, Error>;
96
97/// Alias for the Result type returned by document-builder functions in this
98/// module.
99pub type BuildResult<T> = std::result::Result<T, BuildError>;
100
101/// Keywords that can be encoded (written) into a (being-built) network document
102pub trait KeywordEncodable {
103    /// Encoding of the keyword.
104    ///
105    /// Used for error reporting, and also by `NetdocEncoder::item`.
106    fn to_str(self) -> &'static str;
107}
108
109impl KeywordEncodable for &'static str {
110    fn to_str(self) -> &'static str {
111        self
112    }
113}
114
115/// Indicates whether we should parse an annotated list of objects or a
116/// non-annotated list.
117#[derive(PartialEq, Debug, Eq)]
118#[allow(clippy::exhaustive_enums)]
119pub enum AllowAnnotations {
120    /// Parsing a document where items might be annotated.
121    ///
122    /// Annotations are a list of zero or more items with keywords
123    /// beginning with @ that precede the items that are actually part
124    /// of the document.
125    AnnotationsAllowed,
126    /// Parsing a document where annotations are not allowed.
127    AnnotationsNotAllowed,
128}
129
130/// A "normally formatted" argument to a netdoc item
131///
132/// A type that is represented as a single argument
133/// whose representation is as for the type's `FromStr` and `Display`.
134///
135/// Implementing this trait enables a blanket impl of
136/// [`parse2::ItemArgumentParseable`] (if `FromStr`)
137/// and
138/// [`encode::ItemArgument`] (if `Display`).
139pub trait NormalItemArgument {}
140// TODO: should we implement ItemArgument for, say, tor_llcrypto::pk::rsa::RsaIdentity ?
141// It's not clear whether it's always formatted the same way in all parts of the spec.
142// The Display impl of RsaIdentity adds a `$` which is not supposed to be present
143// in (for example) an authority certificate (authcert)'s "fingerprint" line.
144
145impl NormalItemArgument for usize {}
146impl NormalItemArgument for u8 {}
147impl NormalItemArgument for u16 {}
148impl NormalItemArgument for u32 {}
149impl NormalItemArgument for u64 {}
150impl NormalItemArgument for u128 {}
151
152impl NormalItemArgument for isize {}
153impl NormalItemArgument for i8 {}
154impl NormalItemArgument for i16 {}
155impl NormalItemArgument for i32 {}
156impl NormalItemArgument for i64 {}
157impl NormalItemArgument for i128 {}
158
159impl NormalItemArgument for String {}
160
161/// Return a list of the protocols [supported](tor_protover::doc_supported)
162/// by this crate.
163pub fn supported_protocols() -> tor_protover::Protocols {
164    use tor_protover::named::*;
165    // WARNING: REMOVING ELEMENTS FROM THIS LIST CAN BE DANGEROUS!
166    // SEE [`tor_protover::doc_changing`]
167    [
168        DESC_CROSSSIGN,
169        DESC_NO_TAP,
170        DESC_FAMILY_IDS,
171        MICRODESC_ED25519_KEY,
172        MICRODESC_NO_TAP,
173        CONS_ED25519_MDS,
174    ]
175    .into_iter()
176    .collect()
177}
178
179#[cfg(test)]
180mod test {
181    // @@ begin test lint list maintained by maint/add_warning @@
182    #![allow(clippy::bool_assert_comparison)]
183    #![allow(clippy::clone_on_copy)]
184    #![allow(clippy::dbg_macro)]
185    #![allow(clippy::mixed_attributes_style)]
186    #![allow(clippy::print_stderr)]
187    #![allow(clippy::print_stdout)]
188    #![allow(clippy::single_char_pattern)]
189    #![allow(clippy::unwrap_used)]
190    #![allow(clippy::unchecked_time_subtraction)]
191    #![allow(clippy::useless_vec)]
192    #![allow(clippy::needless_pass_by_value)]
193    #![allow(clippy::string_slice)] // See arti#2571
194    //! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
195
196    use super::*;
197
198    #[test]
199    fn protocols() {
200        let pr = supported_protocols();
201        let expected = "Cons=2 Desc=2-4 Microdesc=2-3".parse().unwrap();
202        assert_eq!(pr, expected);
203    }
204}
tor_netdoc/lib.rs

tor_netdoc/
lib.rs
