mirrors/arti.git/crates/tor-circmgr/src, branch arti-v0.0.1

Merge remote-tracking branch 'origin/mr/112'

2021-10-29T13:16:44Z

Improve docs of more (potentially re-exported) arti-client types

2021-10-29T13:06:06Z

Most of the structs in `arti-client` have example code now, to give a clearer idea of how they're used. Annoyingly, a lot of the types exposed in `arti-client` are actually re-exports, which makes documentation a bit harder: example code that references other parts of `arti-client` can't actually be run as a doctest, since the crate it's in is a dependency of `arti-client`. We might be able to fix this in future by doing the documentation in `arti-client` itself, but rustdoc seems to have some weird behaviours there that need to be investigated first (for example, it seems to merge the re-export and original documentation, and also put the re-export documentation on the `impl` block for some reason). For now, though, this commit just writes the docs from the point of view of an `arti-client` consumer, removing notes specific to the crate in which they're defined. It's not ideal, but at least the end user experience is decent.

Improve some documentation links

2021-10-29T12:39:04Z

Instead of putting a fully qualified name in the text, in most cases we should just use the short name of the type or function we're referring to. In other words, instead of saying [`crate::module::Foo`], we should typically say [`Foo`](crate::module::Foo).

Try writing a bit more documentation for configuration types.

2021-10-29T00:49:17Z

Fix clippy warnings in tests.

2021-10-28T15:44:09Z

Merge remote-tracking branch 'origin/mr/110'

2021-10-28T15:40:18Z

Mark request_retried test as ignored

2021-10-28T15:30:16Z

tor_circmgr: Refactor and re-enable build_timeout() test

2021-10-27T20:31:31Z

The previous version of this test used the old, racy version of wait_for (see #149). The new version is refactored so that simulated time is only allowed to advance after each step is done, so that we can actually be sure that each step in the process will happen as it should. In order to get the time-advances to proceed properly, and avoid polluting state between tests, I've had to introduce some machinery to encode the proper amount for time to advance. It isn't something I'd want to use for a whole bunch of tests, but for just one set, it's fine. These tests now pass reliably for me. I wonder if a discrete-event-simulation approach (hello, Shadow) would let us write tests like these to our hearts' content?

Update our disclaimers and limitations sections.

2021-10-27T15:13:46Z

Add #[serde(flatten)] HashMap fields to serializable objects

2021-10-27T12:31:52Z

As per arti#175, we'd like to be able to handle newer Arti versions storing additional state in the persisted state files, without dropping this data on the floor when we write out changes to these files. Use the #[serde(flatten)] mechanism to achieve this, by adding catch-all HashMap fields to all structs that are at risk of this happening to them.