arti_client: Add a warning comment to TorAddrError.

This commit is contained in:
Nick Mathewson 2023-06-28 08:32:59 -04:00
parent 800061e70e
commit 6c06acc02c
1 changed files with 3 additions and 0 deletions

View File

@ -344,6 +344,9 @@ impl std::fmt::Display for TorAddr {
} }
/// An error created while making or using a [`TorAddr`]. /// An error created while making or using a [`TorAddr`].
//
// NOTE: Unlike ErrorDetail, this is a `pub` enum: Do not make breaking changes
// to it, or expose lower-level errors in it, without careful consideration!
#[derive(Debug, Error, Clone, Eq, PartialEq)] #[derive(Debug, Error, Clone, Eq, PartialEq)]
#[non_exhaustive] #[non_exhaustive]
// TODO Should implement ErrorKind // TODO Should implement ErrorKind