aboutsummaryrefslogtreecommitdiff
path: root/crates/tor-cell/src
Commit message (Collapse)AuthorAgeFilesLines
* Replace manual Default impl with std derive in tor-cellIan Jackson2022-03-021-6/+1
|
* Merge branch 'clippy-allow-arc-clone' into 'main'Nick Mathewson2022-03-011-1/+0
|\ | | | | | | | | Disable clippy::clone_on_ref_ptr See merge request tpo/core/arti!352
| * 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.
* | Give specific error kinds to different END reasonsNick Mathewson2022-02-231-0/+21
|/ | | | Closes #360.
* Remove clippy::needless_borrow exception in CI.Nick Mathewson2022-02-201-1/+0
| | | | | This exception is no longer necessary now that the underlying CI bug is fixed.
* Merge branch 'clippy-followup' into 'main'Nick Mathewson2022-02-171-3/+3
|\ | | | | | | | | Remove some needless refs and slicing See merge request tpo/core/arti!327
| * Remove some needless refs and slicingIan Jackson2022-02-171-3/+3
| | | | | | | | | | Prompted by nightly's clippy (which has some false positives, so is currently disabled).
* | Merge branch 'ptr_arg_fix' into 'main'Ian Jackson2022-02-171-1/+0
|\| | | | | | | | | Re-enable clippy::ptr_arg where it had been disabled. See merge request tpo/core/arti!323
| * Re-enable clippy::ptr_arg where it had been disabled.Nick Mathewson2022-02-161-1/+0
| | | | | | | | | | | | | | | | | | | | In one of the two places, nightly no longer warns. In the other place, it's fine for nightly to warn: I just fixed the code to take a slice instead. Partial revert of 856aca879151c622512bc4b15c6307808fc83e82. Resolves part of #310.
* | Update tor-cell errors to latest APINick Mathewson2022-02-151-4/+4
| |
* | tor-cell: provide HasKind.Nick Mathewson2022-02-153-13/+22
|/ | | | | | | | | Additionally, refactor the IoError out of tor_cell::Error: nothing in TorCell created this; it was only used by tor_proto. This required refactoring in tor_proto to use a new error type. Here I decided to use a new CodecError for now, though we may refactor that away soon too.
* Change deny(clippy::all) to warn(clippy::all).Nick Mathewson2022-02-141-1/+1
| | | | Closes #338.
* Temporarily disable some clippy lints on nightlyIan Jackson2022-02-022-0/+2
|
* extend lints to include 'clippy::all'Daniel Eades2021-12-281-0/+1
|
* tor-cell: replace an XXXX with a TODO.Nick Mathewson2021-12-161-1/+6
| | | | | The original comment was a gnomic question about what to box; the real issue is that we want to avoid copying data in our critical path.
* Extend trace messages for destroy/truncated reasons.Nick Mathewson2021-12-152-18/+43
| | | | | | | | | | | | It makes sense to put the method for human-readable strings onto the type itself, so that we can format these whenever they occur. I'm choosing the "human_str" method name here, since caret-generated types already have a to_str. I was thinking about using Display, but caret types already implement that. I've also moved the message from "warn!" to "debug!", since these aren't necessarily a problem condition.
* Merge remote-tracking branch 'origin/mr/191'Nick Mathewson2021-12-151-0/+19
|\
| * Methodize the destroy circuit reasonNeel Chauhan2021-12-141-3/+18
| |
| * Log on TRUNCATED cellNeel Chauhan2021-12-131-0/+4
| |
* | Actually decrement the stream-level SENDME windoweta2021-12-141-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | arti!126 overhauled the `tor-proto` circuit reactor, but left out one very important thing: actually decrementing the SENDME window for streams (not circuits) when we send cells along them. Since the circuit-level SENDME window would often prevent us from running into a problem, this wasn't caught until my benchmarking efforts noticed it (in the form of Tor nodes aborting the circuit for a protocol violation). fixes arti#260
* | s/hidden/onion/g in code commentsNeel Chauhan2021-12-131-1/+1
|/
* Treat unrecognized SENDME versions as an error.Nick Mathewson2021-12-081-2/+1
| | | | | | We should never get one of these unless we have opted in to get it. (This behavior is the same as C tor.)
* Resolve roughly half of the XXXXs.Nick Mathewson2021-12-061-3/+3
| | | | | | | | We want to only use TODO in the codebase for non-blockers, and open tickets for anything that is a bigger blocker than a TODO. These XXXXs seem like definite non-blockers to me. Part of arti#231.
* add semicolons if nothing returnedDaniel Eades2021-11-253-8/+9
|
* deglob some enums, use concise iteration syntaxDaniel Eades2021-11-252-20/+18
|
* Update our disclaimers and limitations sections.Nick Mathewson2021-10-271-9/+0
|
* enable checked_conversions lint.Nick Mathewson2021-10-093-18/+39
|
* Document every macro.Nick Mathewson2021-09-071-1/+2
| | | | | (The nightly version of clippy now includes macros for its missing_docs_in_private_items lint.)
* Move all crates into a `crates` subdirectory.Nick Mathewson2021-08-277-0/+2965
This will cause some pain for now, but now is really the best time to do this kind of thing.
generated by cgit v1.2.3 (git 2.46.0) at 2026-08-26 19:28:47 +0000