summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Kreutz <mail@skreutz.com>2022-12-11 14:37:08 +0100
committerStefan Kreutz <mail@skreutz.com>2022-12-11 14:37:08 +0100
commite0bbfc07afaf36cbd1dd8d6bfe442dcf9f9a69b7 (patch)
treee03217d928ac9a5f841a93bad5c5a434cefb7568
parent01d423fac53d0d1976c6d2c8dccf7f8eb62a969c (diff)
downloadwpa-psk-e0bbfc07afaf36cbd1dd8d6bfe442dcf9f9a69b7.tar
Deny missings docs
-rw-r--r--wpa-psk-cli/src/bin/wpa-psk.rs3
-rw-r--r--wpa-psk/src/lib.rs8
2 files changed, 11 insertions, 0 deletions
diff --git a/wpa-psk-cli/src/bin/wpa-psk.rs b/wpa-psk-cli/src/bin/wpa-psk.rs
index b9e0e38..22404eb 100644
--- a/wpa-psk-cli/src/bin/wpa-psk.rs
+++ b/wpa-psk-cli/src/bin/wpa-psk.rs
@@ -1,4 +1,7 @@
+//! A command-line utility to compute the WPA-PSK of a Wi-Fi SSID and passphrase.
+
#![forbid(unsafe_code)]
+#![deny(missing_docs)]
use std::process::exit;
diff --git a/wpa-psk/src/lib.rs b/wpa-psk/src/lib.rs
index 56bbf11..5acf8e5 100644
--- a/wpa-psk/src/lib.rs
+++ b/wpa-psk/src/lib.rs
@@ -26,6 +26,7 @@
//! ```
#![forbid(unsafe_code)]
+#![deny(missing_docs)]
use std::{error::Error, fmt::Display};
@@ -59,9 +60,12 @@ impl<'a> TryFrom<&'a str> for Ssid<'a> {
}
}
+/// SSID validation error.
#[derive(Debug, PartialEq, Eq)]
pub enum ValidateSsidError {
+ /// SSID is too short.
TooShort,
+ /// SSID is too long.
TooLong,
}
@@ -111,10 +115,14 @@ impl Display for Passphrase<'_> {
}
}
+/// Passphrase validation error.
#[derive(Debug, PartialEq, Eq)]
pub enum ValidatePassphraseError {
+ /// Passphrase is too short.
TooShort,
+ /// Passphrase is too long.
TooLong,
+ /// Passphrase contains a invalid byte.
InvalidByte,
}
Generated by cgit. See skreutz.com for my tech blog and contact information.