summaryrefslogtreecommitdiff
path: root/crates/tor-protover/src/lib.rs
Commit message (Collapse)AuthorAgeFilesLines
* Allow clippy::collapsible_if to triggerGabriela Moldovan2026-02-161-0/+1
| | | | | | | | | `clippy::collapsible_if` started triggering after bumping the MSRV to 1.88. Since this triggers from a lot of places, and since there even are a couple of instances where we explicitly allow `clippy::collapsible_ifs`, I've opened #2342 for deciding what to do about it.
* maint/add_warning: Run script to add new warningGabriela Moldovan2026-01-271-0/+1
| | | | This adds the lint to all our crates.
* protover: document interning in Protocols docs.Nick Mathewson2025-12-041-0/+8
|
* protover: Intern ProtocolsInner.Nick Mathewson2025-12-031-1/+10
| | | | | This will help us with all the places we want to copy around Protocols objects.
* protover: Make Protocols become an Arc internally.Nick Mathewson2025-12-031-25/+42
| | | | This will help us make it self-interning.
* protover: Document un-recommended usage of Protocols::new()Nick Mathewson2025-12-031-0/+7
|
* Fix name of clippy lint to unchecked_time_subtraction (2)Ian Jackson2025-11-061-2/+2
| | | | Run maint/add_warning
* Remove "doc_auto_cfg" incantation from all crates.Nick Mathewson2025-09-291-1/+1
| | | | This feature has been removed from nightly, in favor of doc_cfg.
* tor-protover: small comment formatting fixSteven Engler2025-08-061-1/+1
| | | | | This breaks the syntax highlighting in vim for some reason and makes the file unreadable for me.
* Temporarily suppress mismatched_lifetime_syntaxes.Gabriela Moldovan2025-07-071-0/+1
| | | | See #2060.
* protover: New `NumberedSubver` to represent a subprotocol capNick Mathewson2025-05-071-1/+81
| | | | | This type differs from `NamedSubver` in that the represented subprotocol capability isn't necessarily recognized or valid.
* protover: Change ProtoKind to be a u8Nick Mathewson2025-05-071-2/+2
| | | | | It is not remotely close to exhausting a u8, and several of our protocols expect it to be expressible as one.
* protover, *: Add documentation about what "supported" means.Nick Mathewson2025-04-161-0/+21
|
* protover: Enforce that every unrecognized protocol entry is nonzero.Nick Mathewson2025-04-161-1/+5
| | | | This rule makes PartialEq more sensible.
* Add warnings about removing supported protocols.Nick Mathewson2025-04-161-0/+35
|
* protover,netdoc: Implement serde for Protocols etc.Nick Mathewson2025-04-161-0/+4
|
* New functions to report supported subprotocolsNick Mathewson2025-04-161-0/+7
| | | | | | | | | | | | | | | Part of #1849. Note that these functions are distributed across crates, so that if (in the future) we stop doing API breaks with every release, we will get the right outputs. Note also that these functions build the list of protocols out of specific symbolic features, rather than numbers: this makes it easier to avoid errors about "which feature was Relay=4 again", and easier to avoid accidentally referring to a protocol that doesn't exist, like "Consensus" (should be "Cons") or "HsDir" (case is wrong).
* protover: Correct capitalization of Micro[Dd]escNick Mathewson2025-04-161-9/+9
| | | | Closes #1923
* protover: Add an implementation for FromIteratorNick Mathewson2025-04-161-0/+37
|
* protover: document and enforce more invariantsNick Mathewson2025-04-161-3/+19
| | | | | | | | We have places where, if we were to create certain ProtoKinds or NamedProtos with invalid values, we could cause a panic. This isn't remotely triggerable, or even triggerable from outside the protover crate, but it's best to avoid the possibility of future mistakes.
* protover: New function to intersect Protocols sets.Nick Mathewson2025-04-161-0/+53
| | | | | This will be helpful in building a list of protocols from several crates.
* protover: New function to combine (union) Protocols sets.Nick Mathewson2025-04-161-1/+57
| | | | | This will be helpful in building a list of protocols from several crates.
* protover: New function to subtract to Protocols sets.Nick Mathewson2025-04-161-0/+54
| | | | | This will be helpful in checking whether a list of protocols has any unsupported members.
* protover: Add support for subprotocol version mnemonics.Nick Mathewson2025-03-121-0/+30
| | | | | | | | It's error-prone to have to remember e.g. that "Desc=5" means "family ID support", so in torspec!251 we added mnemonic names like DESC_FAMILY_IDS. Here we use those names in tor-protover.
* protover: Add Conflux protocol group.Nick Mathewson2025-03-121-1/+3
|
* clippy: deny `mod_module_files`Steven Engler2025-01-061-0/+1
| | | | | | Denies 'mod.rs' files for consistency. https://rust-lang.github.io/rust-clippy/master/index.html#mod_module_files
* add_warnings, *: Allow clippy::needless_lifetimesNick Mathewson2024-12-031-0/+1
| | | | | | | | In 1.83, this warning triggers on many of our crates. We're thinking of fixing them all, but for now, we're going to disable the warning. This is part of #1765.
* Re-run maint/add_warning.Nick Mathewson2024-05-061-2/+2
| | | | This commit is automatically generated.
* Run maint/add_warning.Nick Mathewson2024-03-131-0/+1
|
* deny clippy::unchecked_duration_subtractiontrinity-1686a2024-02-291-0/+1
|
* Run maint/add_warning to add lint block everywhereIan Jackson2023-08-231-0/+1
|
* Run add_warnings on all files.Nick Mathewson2023-08-041-2/+2
|
* Run maint/add_warning to actually apply new lint allowsIan Jackson2023-07-101-0/+2
|
* Run add_warning to remove `missing_panics_doc` deny.Nick Mathewson2023-07-061-1/+0
| | | | Closes #950.
* lints: Run maint/add_warning to actually apply new lintsIan Jackson2023-06-211-0/+2
|
* Allow clippy::unchecked_duration_subtraction in testsNick Mathewson2023-01-271-0/+1
| | | | | This panics on error, and we're fine with a panic on misbehavior in tests.
* Disable clippy::unlinlined-format-argsNick Mathewson2023-01-271-0/+1
| | | | | | | | This warning kind of snuck up on us! (See #748) For now, let's disable it. (I've cleaned it up in a couple of examples, since those are meant to be more idiomatic and user-facing.) Closes #748.
* test lint blocks: Add many many automaticallyIan Jackson2022-12-121-0/+8
| | | | | This is precisely the result of running the rune in maint/adhoc-add-lint-blocks.
* Run add_warnings.Nick Mathewson2022-11-031-0/+1
|
* cargo fmt to remove blank linesIan Jackson2022-10-121-1/+0
| | | | | | | Apparently cargo fmt doesn't like these, which my perl rune didn't delete. This commit is precisely the result of `cargo fmt`.
* Replace all README copies in src/lib.rs with includesIan Jackson2022-10-121-34/+1
| | | | | | | | The feature we want is `#[doc = include_str!("README.md")]`, which is stable since 1.54 and our MSRV is now 1.56. This commit is precisely the result of the following Perl rune: perl -i~ -0777 -pe 's{(^//!(?!.*\@\@).*\n)+}{#![doc = include_str!("../README.md")]\n}m' crates/*/src/lib.rs
* enable doc_auto_cfg feature on every crate when documenting for docs.rstrinity-1686a2022-08-241-0/+1
|
* Run maint/add_warning crates/*/src/{lib,main}.rsIan Jackson2022-06-231-0/+3
| | | | Update all lint blocks
* Style fixes to tor-protover errors.Nick Mathewson2022-06-221-3/+3
|
* lints: tor-protover: Move two allows outside the auto blockIan Jackson2022-05-311-2/+3
| | | | These need to survive.
* lints: Add let_unit_value allow to all cratesIan Jackson2022-05-311-0/+1
| | | | | From running add_warning, with manual picking of the right hunks/lines.
* lints: Add lint block delimiters to every crateIan Jackson2022-05-311-0/+2
| | | | | | This was the result of: maint/add_warning crates/*/src/{lib,main}.rs and then manually curating the results.
* Canonicalize and intern protover lines on descriptorsNick Mathewson2022-03-111-3/+5
| | | | | | | | This should save around 1MB per consensus, since every relay has a 'protocols' lines, but there are only a few distinct possibilities for such a line. Closes #385.
* Replace manual Default and new with std derive in tor-protoIan Jackson2022-03-021-11/+2
|
* Disable clippy::clone_on_ref_ptrIan Jackson2022-02-241-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This lint is IMO inherently ill-conceived. I have looked for the reasons why this might be thought to be a good idea and there were basically two (and they are sort of contradictory): I. "Calling ‘.clone()` on an Rc, Arc, or Weak can obscure the fact that only the pointer is being cloned, not the underlying data." This is the wording from https://rust-lang.github.io/rust-clippy/v0.0.212/#clone_on_ref_ptr It is a bit terse; we are left to infer why it is a bad idea to obscure this fact. It seems to me that if it is bad to obscure some fact, that must be because the fact is a hazard. But why would it be a hazard to not copy the underlying data ? In other languages, faliing to copy the underlying data is a serious correctness hazard. There is a whose class of bugs where things were not copied, and then mutated and/or reused in multiple places in ways that were not what the programmer intended. In my experience, this is a very common bug when writing Python and Javascript. I'm told it's common in golang too. But in Rust this bug is much much harder to write. The data inside an Arc is immutable. To have this bug you'd have use interior mutability - ie mess around with Mutex or RefCell. That provides a good barrier to these kind of accidents. II. "The reason for writing Rc::clone and Arc::clone [is] to make it clear that only the pointer is being cloned, as opposed to the underlying data. The former is always fast, while the latter can be very expensive depending on what is being cloned." This is the reasoning found here https://github.com/rust-lang/rust-clippy/issues/2048 This is saying that *not* using Arc::clone is hazardous. Specifically, that a deep clone is a performance hazard. But for this argument, the lint is precisely backwards. It's linting the "good" case and asking for it to be written in a more explicit way; while the supposedly bad case can be written conveniently. Also, many objects (in our codebase, and in all the libraries we use) that are Clone are in fact simply handles. They contain Arc(s) (or similar) and are cheap to clone. Indeed, that is the usual case. It does not make sense to distinguish in the syntax we use to clone such a handle, whether the handle is a transparent Arc, or an opaque struct containing one or more other handles. Forcing Arc::clone to be written as such makes for code churn when a type is changed from Arc<Something> to Something: Clone, or vice versa.