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

tor_netdoc/
lib.rs
