errors: Add some TODOs as per discussion comments

This commit is contained in:
Ian Jackson 2022-02-04 14:49:06 +00:00
parent 87270415f0
commit 5b54d3e08e
2 changed files with 8 additions and 0 deletions

View File

@ -21,6 +21,9 @@ macro_rules! define_according_to_cfg_error_details { { $vis:vis } => {
/// to check what kind of error it is,
#[derive(Error, Debug)]
// TODO #[derive(Clone)] // we need to make everything inside Clone first
// TODO Use assert_impl! or something to ensure this is Send Sync Clone Debug Display 'static
// as per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/262#note_2772823
// bullet point 5
#[allow(clippy::exhaustive_structs)]
pub struct TorError {
/// The actual error

View File

@ -34,6 +34,11 @@ pub enum Error {
/// Who we were talking to
peer: SocketAddr,
// TODO
// /// What we were doing
// action: &'static str,
// as per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/262#note_2772820
/// What happened. Might be some TLS library error wrapped up in io::Error
#[source]
source: Arc<std::io::Error>,