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

tor_netdoc/
lib.rs
