docs: add doc-comments to new errors

This commit is contained in:
DarkCat09 2024-08-15 17:51:04 +04:00
parent 446bf9f67b
commit 3bce5e603f
Signed by: DarkCat09
GPG key ID: 0A26CD5B3345D6E3

View file

@ -13,7 +13,8 @@ pub enum LibError {
IoError(std::io::Error), IoError(std::io::Error),
/// URL parse or check error /// URL parse or check error
InvalidUrlError(InvalidUrl), InvalidUrlError(InvalidUrl),
/// /// DNS provided no suitable records
/// (e. g. domain does not exist)
HostLookupError, HostLookupError,
/// Response status code is out of [10; 69] range /// Response status code is out of [10; 69] range
StatusOutOfRange(u8), StatusOutOfRange(u8),
@ -22,10 +23,10 @@ pub enum LibError {
DataNotUtf8(std::string::FromUtf8Error), DataNotUtf8(std::string::FromUtf8Error),
/// Provided string is not a valid MIME type /// Provided string is not a valid MIME type
InvalidMime(mime::FromStrError), InvalidMime(mime::FromStrError),
/// /// Hickory Client error
#[cfg(feature = "hickory")] #[cfg(feature = "hickory")]
DnsClientError(HickoryClientError), DnsClientError(HickoryClientError),
/// /// Hickory Proto error
#[cfg(feature = "hickory")] #[cfg(feature = "hickory")]
DnsProtoError(HickoryProtoError), DnsProtoError(HickoryProtoError),
} }